Skip to content

Commit 87c3172

Browse files
authored
Suggest contributors to create a new branch to work on a new issue (#638)
1 parent 7ce60f9 commit 87c3172

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

.github/CONTRIBUTING.rst

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,20 @@ Pull Requests should be small to facilitate easier review. Keep them
2323
self-contained, and limited in scope. Studies have shown that review quality
2424
falls off as patch size grows. Sometimes this will result in many small PRs to
2525
land a single large feature.
26-
2726
Checklist:
2827

29-
1. All pull requests *must* be made against the ``master`` branch.
30-
2. Include tests for any functionality you implement. Contributions that
28+
1. Always create a new branch to work on a new issue::
29+
30+
$ git checkout -b <branch-name>
31+
32+
2. Make sure your branch is up-to-date with upstream master before you file
33+
a pull request.
34+
3. All pull requests *must* be made against the ``master`` branch.
35+
4. Include tests for any functionality you implement. Contributions that
3136
improve existing tests are welcome.
32-
3. Update documentation as necessary and provide documentation for any new
37+
5. Update documentation as necessary and provide documentation for any new
3338
functionality.
34-
4. In case of UI changes, please include screenshots.
35-
5. Add yourself to ``CONTRIBUTORS.txt`` if you're not there already. :)
39+
6. In case of UI changes, please include screenshots.
3640

3741
If you do make any changes to models (modification or addition), make sure to
3842
run ``python manage.py makemigrations`` to enable the server to migrate existing

0 commit comments

Comments
 (0)