diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1281f48fe..21b673a76 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,12 +2,25 @@ ## Process -1. Submit an issue describing the changes you want to implement. (If it's only minor changes/bug-fixes, you can skip to step 3.) -2. After the scope was discussed in the issue, assign it to yourself. (It should show up in the "In progress" column in the OpenBot project.) +1. Submit an issue describing the changes you want to implement. If it's only minor changes/bug-fixes, you can skip to step 3. +2. After the scope was discussed in the issue, assign it to yourself. It should show up in the "To do" column in the OpenBot project. 3. Fork the project and clone it locally. -4. Create a branch and name it `-` where `` concisely describes the scope of the work. + + `git clone https://github.com//OpenBot.git` + +4. Create a branch and name it `/` where `` concisely describes the scope of the work. + + `git checkout -b /` + 5. Do the work, write good commit messages, push your branch to the forked repository. -6. Create a [pull request](https://github.com/intel-isl/OpenBot/pulls) in GitHub and link the issue to it. + + ``` + git add + git commit -m + git push --set-upstream origin / + ``` + +6. Create a [pull request](https://github.com/intel-isl/OpenBot/pulls) in GitHub and link the issue to it. It should show up in the "In progress" column in the OpenBot project. 7. Work on any code review feedback you may receive and push it to your fork. The pull request gets updated automatically. 8. Get a cold drink of your choice to reward yourself for making the world a better place.