From b77f3853f33b27d68d3fb9aa8074a9bdd413aae4 Mon Sep 17 00:00:00 2001 From: Sunayana Ghosh Date: Thu, 29 Apr 2021 14:06:49 +0200 Subject: [PATCH] #20 Adds instructions for development. --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 4b6a0dc..333a599 100644 --- a/README.md +++ b/README.md @@ -254,9 +254,34 @@ Clone the project: $ git clone git@github.com:/WRI_WellBeing_Data_Layer.git ``` Add [this](https://github.com/cmougan/WRI_WellBeing_Data_Layer) repository as a remote and name it `upstream`. Clone of your own fork is named `origin`. + +For further instructions for setting up, please follow the steps [here](./dssg/README.md) ### Main Components TODO ### Contribution Guidelines +In general we follow the [GitHub Forking Workflow](https://guides.github.com/activities/forking/) +#### On GitHub +- Create an issue for each new bug/feature/update/documentation that you want to contribute to. In the issue description, be as detailed as possible with the expected inputs, outputs and an outline of the process to solve the problem. In case of a bug add the steps needed to reproduce it. +- Assign someone to the issue and apply a specific tag to it (documentation, enhancement, bug, etc.). + +#### On your local machine +- To start working on an issue create a separate branch : +``` +git checkout -b feature/ +``` +if it is a feature or +``` +git checkout -b bug/ +``` +substitute the `` with a descriptive name. +- Once your work is done, commit and push: +``` +git push -u origin feature/ +``` + +#### Back on GitHub +- Once issue is solved, make a Pull Request (PR) on GitHub to merge to master branch and link the issue in the PR description and assign people to review your PR. +- Once the PR get approved and merged, delete the branch and close the issue. ## Project Organization ### Solve For Good Collaborators