Skip to content

Latest commit

 

History

History
52 lines (40 loc) · 1.58 KB

CONTRIBUTING.rst

File metadata and controls

52 lines (40 loc) · 1.58 KB
Raw

Contributing to pytest-darker

This is a micro project with a small code base, few contributors and hobby maintainership. For this reason, please don't expect immediate responses to bug reports and pull requests. They will all be responded to eventually.

We follow common conventions and code of conduct for Open Source collaboration on GitHub.

Some additional simple guidelines:

Bug reports

Please include

  • release or Git commit for the version of pytest-darker and Darker you're using
  • Python, Pytest, Black and isort versions
  • your Pytest command line
  • file to be tested as an attachment, if possible – also great if squeezed down to a minimal example
  • resulting output or error message
  • expected output

Pull requests

To speed up review and increase odds for the PR to be accepted, please

  • keep all code black & isort formatted
  • include a test case for new or modified code
  • use type hinting
  • make sure the test suite passes
  • verify that mypy static type checking passes
  • document new features or changed behavior in README.rst
  • summarize end-user affecting changes in CHANGES.rst
  • add your information in CONTRIBUTORS.rst

GitHub is configured to use Travis CI on each pull request to

  • run the test suite using Pytest
  • do static type checking using Mypy
  • check code formatting using Black