-
Notifications
You must be signed in to change notification settings - Fork 142
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
1 parent
26e2036
commit cfd5442
Showing
1 changed file
with
35 additions
and
4 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 |
---|---|---|
@@ -1,5 +1,36 @@ | ||
Contributing | ||
============ | ||
How to properly sending bug reports | ||
=================================== | ||
|
||
Thanks for your interest! We love contributions, so please feel free to fix bugs, improve things, provide documentation. Just `follow the | ||
guidelines <http://djangonauts.github.io/django-hstore/#_developers_guide>`_ and submit a PR. | ||
We review and fix bugs in our free time, which is a scarce resource. | ||
|
||
That means that if you don't report the bug properly it may take months to verify and fix it. | ||
|
||
A proper bug report should include: | ||
|
||
* python version | ||
* django version | ||
* django-hstore version | ||
* a high level procedure that explains how to reproduce the bug or a failing test case if it is a bug which is complex to reproduce | ||
|
||
`See also guidelines on how to run the test suite <http://djangonauts.github.io/django-hstore/#_developers_guide>`_. | ||
|
||
How to send a patch to fix a bug | ||
================================ | ||
|
||
If you think you found a bug, you must first ensure it's reproduce in the test suite. | ||
|
||
Patches without failing tests won't be accepted. | ||
|
||
Avoid multiple commits and ensure the commit message is clear. | ||
|
||
`See also guidelines on how to run the test suite <http://djangonauts.github.io/django-hstore/#_developers_guide>`_. | ||
|
||
Things to avoid | ||
=============== | ||
|
||
Do not create a separate project to explain the bug, that is worse than useless, it only gives us headaches and wastes our time. | ||
|
||
Thank you | ||
========= | ||
|
||
Thank you for taking the time to read these guidelines. |