Skip to content

Commit

Permalink
doc - Add contributing information
Browse files Browse the repository at this point in the history
  • Loading branch information
phibos committed Apr 13, 2017
1 parent e90e599 commit a38425d
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
Contributing
============

First of all, thank you for your interest in contributing to this project!


Filing bug reports
------------------

Bug reports are very welcome.
Please file them on the `GitHub issue tracker`_.
Good bug reports come with extensive descriptions of the error and how to reproduce it.
Try to use the provided issue template, it should be displayed by the GitHub website when creating a new issue.


Patches
-------

All patches should be submitted in the form of pull requests to the main repository, `DinoTools/python-ssdeep`_.
These pull requests should satisfy the following properties:

Code
^^^^

- A pull request should focus on **one** particular improvement or change.
- Create different pull requests for unrelated features or bugfixes.
- Python code should follow `PEP 8`_, especially in the "do what code around you does" sense.
- Add test if possible


Documentation
^^^^^^^^^^^^^

When introducing new functionality, please remember to write documentation.


Review
------

Finally, pull requests must be reviewed before merging.
Everyone can perform reviews; this is a very valuable way to contribute, and is highly encouraged.


.. _GitHub issue tracker: https://github.com/DinoTools/python-ssdeep/issues
.. _DinoTools/python-ssdeep: https://github.com/DinoTools/python-ssdeep
.. _PEP 8: https://www.python.org/dev/peps/pep-0008/

0 comments on commit a38425d

Please sign in to comment.