Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
thias15 authored Sep 29, 2020
1 parent 8cb5c28 commit 6ff62a4
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<user_id>-<feature>` where `<feature>` concisely describes the scope of the work.

`git clone https://github.com/<user_id>/OpenBot.git`

4. Create a branch and name it `<user_id>/<feature>` where `<feature>` concisely describes the scope of the work.

`git checkout -b <user_id>/<feature>`

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 <modified file>
git commit -m <meaningful description>
git push --set-upstream origin <user_id>/<feature>
```

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.

Expand Down

0 comments on commit 6ff62a4

Please sign in to comment.