Skip to content

Commit 0a62a97

Browse files
authored
improve contributing docs (#891)
1 parent 02a872c commit 0a62a97

File tree

1 file changed

+71
-1
lines changed

1 file changed

+71
-1
lines changed

docs/contributing.rst

Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22
Contributing
33
============
44

5+
.. image:: https://jazzband.co/static/img/jazzband.svg
6+
:target: https://jazzband.co/
7+
:alt: Jazzband
8+
9+
This is a `Jazzband <https://jazzband.co>`_ project. By contributing you agree to abide by the `Contributor Code of Conduct <https://jazzband.co/about/conduct>`_ and follow the `guidelines <https://jazzband.co/about/guidelines>`_.
10+
11+
512
Setup
613
=====
714

@@ -70,7 +77,7 @@ When you begin your PR, you'll be asked to provide the following:
7077
JazzBand security team `<[email protected]>`. Do not file an issue on the tracker
7178
or submit a PR until directed to do so.)
7279

73-
* Make sure your name is in `AUTHORS`.
80+
* Make sure your name is in `AUTHORS`. We want to give credit to all contrbutors!
7481

7582
If your PR is not yet ready to be merged mark it as a Work-in-Progress
7683
By prepending `WIP:` to the PR title so that it doesn't get inadvertently approved and merged.
@@ -106,6 +113,29 @@ How to get your pull request accepted
106113

107114
We really want your code, so please follow these simple guidelines to make the process as smooth as possible.
108115

116+
The Checklist
117+
-------------
118+
119+
A checklist template is automatically added to your PR when you create it. Make sure you've done all the
120+
applicable steps and check them off to indicate you have done so. This is
121+
what you'll see when creating your PR:
122+
123+
Fixes #
124+
125+
## Description of the Change
126+
127+
## Checklist
128+
129+
- [ ] PR only contains one change (considered splitting up PR)
130+
- [ ] unit-test added
131+
- [ ] documentation updated
132+
- [ ] `CHANGELOG.md` updated (only for user relevant changes)
133+
- [ ] author name in `AUTHORS`
134+
135+
Any PRs that are missing checklist items will not be merged and may be reverted if they are merged by
136+
mistake.
137+
138+
109139
Run the tests!
110140
--------------
111141

@@ -142,5 +172,45 @@ Try reading our code and grasp the overall philosophy regarding method and varia
142172
the sake of readability, keep in mind that *simple is better than complex*. If you feel the code is not straightforward,
143173
add a comment. If you think a function is not trivial, add a docstrings.
144174

175+
To see if your code formatting will pass muster use: `tox -e py37-flake8`
176+
145177

146178
The contents of this page are heavily based on the docs from `django-admin2 <https://github.com/twoscoops/django-admin2>`_
179+
180+
Maintainer Checklist
181+
====================
182+
The following notes are to remind the project maintainers and leads of the steps required to
183+
review and merge PRs and to publish a new release.
184+
185+
Reviewing and Merging PRs
186+
------------------------
187+
188+
- Make sure the PR description includes the `pull request template
189+
<https://github.com/jazzband/django-oauth-toolkit/blob/master/.github/pull_request_template.md>`_
190+
- Confirm that all required checklist items from the PR template are both indicated as done in the
191+
PR description and are actually done.
192+
- Perform a careful review and ask for any needed changes.
193+
- Make sure any PRs only ever improve code coverage percentage.
194+
- All PRs should be be reviewed by one individual (not the submitter) and merged by another.
195+
196+
PRs that are incorrectly merged may (reluctantly) be reverted by the Project Leads.
197+
198+
199+
Publishing a Release
200+
--------------------
201+
202+
Only Project Leads can publish a release to pypi.org and rtfd.io. This checklist is a reminder
203+
of steps.
204+
205+
- When planning a new release, create a `milestone
206+
<https://github.com/jazzband/django-oauth-toolkit/milestones>`_
207+
and assign issues, PRs, etc. to that milestone.
208+
- Review all commits since the last release and confirm that they are properly
209+
documented in the CHANGELOG. (Unfortunately, this has not always been the case
210+
so you may be stuck documenting things that should have been documented as part of their PRs.)
211+
- Make a final PR for the release that updates:
212+
213+
- CHANGELOG to show the release date.
214+
- setup.cfg to set `version = ...`
215+
216+
- Once the final PR is committed push the new release to pypi and rtfd.io.

0 commit comments

Comments
 (0)