Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

38 lines (27 loc) · 1.43 KB
Raw

Contributing

Thank you for contributing to Relé!

To make the experience as easy as possible, we ask that you follow some simple guidelines. Use your best judgment, and feel free to propose changes to this document in a pull request.

Additionally, be sure that you read and follow our Code of Conduct.

Code

We ask that you start a discussion before attempting to make a code contribution. For feature requests, issues, bugs, etc. please create an issue via Github where we can all discuss the contribution to the project.

It is always best to have community input before proposing changes that may later be rejected.

Pull Requests

  • Make sure any code changes are covered by tests by running make test.
  • Run make lint on any modified files.
  • If your branch is behind master, rebase on top of it.
  • Include the related issue's number so that Github closes automagically when the PR is merged. Example: Fix #12
  • Add yourself to the AUTHORS file

Issues

When you open an issue make sure you include the full stack trace and that you list all pertinent information (operating system, Python implementation, etc.) as part of the issue description.

Please include a minimal, reproducible test case with every bug report.