How To Contribute

Every open source project lives from the generous help by contributors that sacrifice their time and structlog is no different.

Here are a few guidelines to get you started:

  • Try to limit each pull request to one change only.
  • To run the test suite, all you need is a recent tox. It will ensure the test suite runs with all dependencies against all Python versions just as it will on Travis CI. If you lack some Python version, you can can always limit the environments like tox -e py27,py35 (in that case you may want to look into pyenv that makes it very easy to install many different Python versions in parallel).
  • Make sure your changes pass our CI. You won’t get any feedback until it’s green unless you ask for it.
  • If your change is noteworthy, add an entry to the changelog. Use present tense, semantic newlines, and add link to your pull request.
  • No contribution is too small; please submit as many fixes for typos and grammar bloopers as you can!
  • Don’t break backward compatibility.
  • Always add tests and docs for your code. This is a hard rule; patches with missing tests or documentation won’t be merged.
  • Write good test docstrings.
  • Obey PEP 8 and PEP 257.
  • If you address review feedback, make sure to bump the pull request. Maintainers don’t receive notifications if you push new commits.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. Please report any harm to Hynek Schlawack in any way you find appropriate.

Thank you for considering to contribute to structlog!