-
-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Submitting Pull Requests | ||
|
||
## General | ||
|
||
- [ ] Make sure you use [semantic commit messages](https://seesparkbox.com/foundry/semantic_commit_messages). | ||
Examples: `"fix(google): Fixed foobar bug"`, `"feat(accounts): Added foobar feature"`. | ||
- [ ] All Python code must formatted using Black, and clean from pep8 and isort issues. | ||
- [ ] JavaScript code should adhere to [StandardJS](https://standardjs.com). | ||
- [ ] If your changes are significant, please update `ChangeLog.rst`. | ||
- [ ] If your change is substantial, feel free to add yourself to `AUTHORS`. | ||
|
||
## Provider Specifics | ||
|
||
In case you add a new provider: | ||
|
||
- [ ] Make sure unit tests are available. | ||
- [ ] Add an entry of your provider in `test_settings.py::INSTALLED_APPS` and `docs/installation.rst::INSTALLED_APPS`. | ||
- [ ] Add documentation to `docs/providers/<provider name>.rst` and `docs/providers/index.rst` Provider Specifics toctree. | ||
- [ ] Add an entry to the list of supported providers over at `docs/overview.rst`. |