Skip to content

Commit 82a23d6

Browse files
authored
Add basic contribution guidelines
1 parent 263e08f commit 82a23d6

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing
2+
3+
Contributions to `django-postgres-extra` are definitely welcome! Any contribution that implements a PostgreSQL feature in the Django ORM is welcome.
4+
5+
Please use GitHub pull requests to contribute changes.
6+
7+
##
8+
If you're unsure whether your change would be a good fit for `django-postgres-extra`, please submit an issue with the [idea](https://github.com/SectorLabs/django-postgres-extra/labels/idea) label and we can talk about it.
9+
10+
## Requirements
11+
* All contributions must pass our CI.
12+
* Existing tests pass.
13+
* PyLint passes.
14+
* PEP8 passes.
15+
* Features that allow creating custom indexes or fields must also implement the associated migrations. `django-postgres-extra` prides itself on the fact that it integrates smoothly with Django migrations. We'd like to keep it that way for all features.
16+
* Sufficiently complicated changes must be accomponied by tests.
17+
18+
## Our promise
19+
* We'll promise to reply to each pull request within 24 hours of submission.
20+
* We'll let you know whether we welcome the change or not within that timeframe.
21+
* This avoids you wasting time on a feature that we feel is not a good fit.
22+
23+
We feel that these promises are fair to whomever decides its worth spending their free time to contribute to `django-postgres-extra`. Please do let us know if you feel we are not living up to these promises.

0 commit comments

Comments
 (0)