From 5c94520e36031b5ac8a8b0e15e5312c649c225e8 Mon Sep 17 00:00:00 2001 From: Shubham Singh <55784408+shubhamcodez@users.noreply.github.com> Date: Sat, 24 Dec 2022 14:13:29 +0530 Subject: [PATCH 01/17] Create CONTRIBUTING.md --- CONTRIBUTING.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..25b380c8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# Welcome to DiCRA contributing guide +Thank you for investing your time in contributing to our project!✨ + +Read our Code of Conduct to keep our community approachable and respectable. +In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. + +## New Contributor guide +Familiarize yourself with the project's goals and objectives. + +#### For Technical contributions, + + +## Making Contributions + +Submit contributions through pull requests +Include unit tests with code contributions +Consider opening an issue to discuss significant changes +Follow coding standards and style guidelines +Include screenshots or mockups for changes to the user interface +Document new features and functionality +Adhere to the code of conduct +III. Submitting a Pull Request + +Include a clear and concise description of changes +Link to relevant issues +Address comments and suggestions during the review process +Resolve merge conflicts (if necessary) +IV. After Your Pull Request is Merged + +Your contributions will be publicly visible on the GitHub repository +Stay involved and continue to look for ways to contribute to the project. From 3d679f8ceb7bb287708e8a73c252466c895214c1 Mon Sep 17 00:00:00 2001 From: Shubham Singh <55784408+shubhamcodez@users.noreply.github.com> Date: Sat, 24 Dec 2022 14:17:45 +0530 Subject: [PATCH 02/17] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 25b380c8..cfa31233 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,7 +5,7 @@ Read our Code of Conduct to keep our community approachable and respectable. In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. ## New Contributor guide -Familiarize yourself with the project's goals and objectives. +Familiarize yourself with the project's goals and objectives. Go through [ReadMe](https://github.com/shubhamcodez/dicra/blob/main/readme.md) and [Code of Conduct](https://github.com/shubhamcodez/dicra/blob/main/CODE_OF_CONDUCT.md) to better understand our expectations of standard and enforcement guidelines. #### For Technical contributions, ## Making Contributions + -Submit contributions through pull requests -Include unit tests with code contributions -Consider opening an issue to discuss significant changes -Follow coding standards and style guidelines -Include screenshots or mockups for changes to the user interface -Document new features and functionality -Adhere to the code of conduct -III. Submitting a Pull Request +## Submitting a Pull Request Include a clear and concise description of changes Link to relevant issues From 3de58d8fc312f2869ab12becfd1290dfeb7da9ae Mon Sep 17 00:00:00 2001 From: Shubham Singh <55784408+shubhamcodez@users.noreply.github.com> Date: Sat, 24 Dec 2022 14:26:21 +0530 Subject: [PATCH 04/17] Update CONTRIBUTING.md --- CONTRIBUTING.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f8dcdb59..b74a945b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,13 +16,13 @@ Familiarize yourself with the project's goals and objectives. Go through [ReadMe ## Making Contributions ## Submitting a Pull Request From 977515bc2c15e7655dc6e440a2e7d9bf32d26a4e Mon Sep 17 00:00:00 2001 From: Shubham Singh <55784408+shubhamcodez@users.noreply.github.com> Date: Sat, 24 Dec 2022 14:37:42 +0530 Subject: [PATCH 05/17] Update CONTRIBUTING.md --- CONTRIBUTING.md | 35 +++++++++++++++++++++-------------- 1 file changed, 21 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b74a945b..abf2843b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,5 @@ # Welcome to DiCRA contributing guide -Thank you for investing your time in contributing to our project!✨ +Thank you for investing your time in contributing to our project! Read our Code of Conduct to keep our community approachable and respectable. In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. @@ -16,22 +16,29 @@ Familiarize yourself with the project's goals and objectives. Go through [ReadMe ## Making Contributions ## Submitting a Pull Request + -Include a clear and concise description of changes -Link to relevant issues -Address comments and suggestions during the review process -Resolve merge conflicts (if necessary) -IV. After Your Pull Request is Merged - -Your contributions will be publicly visible on the GitHub repository -Stay involved and continue to look for ways to contribute to the project. +## After Your Pull Request is Merged +Congratulations you have successfully contributed to DiCRA.✨ +Your contributions will be publicly visible on the GitHub repository once the merge is complete. From 40132f965fbd3e995e3ea93335b1ce0280245df2 Mon Sep 17 00:00:00 2001 From: Shubham Singh <55784408+shubhamcodez@users.noreply.github.com> Date: Sat, 24 Dec 2022 14:46:39 +0530 Subject: [PATCH 06/17] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index abf2843b..662c2af6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,7 +34,7 @@ Familiarize yourself with the project's goals and objectives. Go through [ReadMe ## Submitting a Pull Request From 04214f333be0fd5a76453e72952895f833d35ec7 Mon Sep 17 00:00:00 2001 From: Shubham Singh <55784408+shubhamcodez@users.noreply.github.com> Date: Sat, 24 Dec 2022 14:58:13 +0530 Subject: [PATCH 07/17] Update CONTRIBUTING.md --- CONTRIBUTING.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 662c2af6..8a9cd6a1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,19 +5,22 @@ Read our Code of Conduct to keep our community approachable and respectable. In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. ## New Contributor guide -Familiarize yourself with the project's goals and objectives. Go through [ReadMe](https://github.com/shubhamcodez/dicra/blob/main/readme.md) and [Code of Conduct](https://github.com/shubhamcodez/dicra/blob/main/CODE_OF_CONDUCT.md) to better understand our expectations of standard and enforcement guidelines. +Familiarize yourself with the project's goals and objectives. Go through [ReadMe](https://github.com/shubhamcodez/dicra/blob/main/readme.md) and [Code of Conduct](https://github.com/shubhamcodez/dicra/blob/main/CODE_OF_CONDUCT.md) to better understand our expectations of standard and enforcement guidelines. If you have never worked with Github, I would suggest Git for [Beginners](https://youtu.be/RGOj5yH7evk) or reading the github [docs](https://docs.github.com/en/get-started). -#### For Technical contributions, +#### Technical contributions, +## Report bugs, add suggestions using Github's issues +We use GitHub issues to track public bugs, take suggestions and feedback. Report bugs, improvement suggestions by opening a new [issue](https://github.com/undpindia/dicra/issues); it's that easy! + ## Making Contributions +While direct merges work great as we work with independent python notebooks, it can get messy and violate our standards sometimes. Here are some recommended guidelines, we insist you follow if you are contributing to the repository for the first time. ## After Your Pull Request is Merged -Congratulations you have successfully contributed to DiCRA.✨ +Congratulations you have successfully contributed to DiCRA.✨
Your contributions will be publicly visible on the GitHub repository once the merge is complete. From b62e67cee984f52b465184f74056ce4a409939be Mon Sep 17 00:00:00 2001 From: Shubham Singh <55784408+shubhamcodez@users.noreply.github.com> Date: Sat, 24 Dec 2022 15:00:06 +0530 Subject: [PATCH 08/17] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8a9cd6a1..bce0b519 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,7 +20,11 @@ We use GitHub issues to track public bugs, take suggestions and feedback. Report While direct merges work great as we work with independent python notebooks, it can get messy and violate our standards sometimes. Here are some recommended guidelines, we insist you follow if you are contributing to the repository for the first time.