Skip to content

Latest commit

 

History

History
92 lines (58 loc) · 2.31 KB

CONTRIBUTING.rst

File metadata and controls

92 lines (58 loc) · 2.31 KB
Raw

Contributing

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

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.

Patches

All patches to dionaea should be submitted in the form of pull requests to the main dionaea repository, DinoTools/dionaea. These pull requests should satisfy the following properties:

Code

  • The pull request should focus on one particular improvement to dionaea.
  • 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.

Documentation

When introducing new functionality, please remember to write documentation.

First time setup

$ git config user.name 'Your Name'
$ git config user.email '[email protected]'
  • Make sure you have a GitHub account
  • Fork dionaea to your GitHub account by using the Fork button
  • Clone the main repository locally
$ git clone https://github.com/DinoTools/dionaea.git
$ cd dionaea
  • Add your fork as a remote to push your work to. Replace <username> with your username.
$ git remote add fork https://github.com/<username>/dionaea

$ python3 -m venv venv_git
$ source venv_git/bin/activate
$ pip install pre-commit
  • Install pre-commit hooks.
$ pre-commit install

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.