Skip to content

Latest commit

 

History

History
38 lines (23 loc) · 1.07 KB

CONTRIBUTING.md

File metadata and controls

38 lines (23 loc) · 1.07 KB
Raw

Contributing to re-com

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to re-com which is hosted on Github. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Creating issues for bugs

Check if the issue has already been reported. If possible provide:

  • Version of re-com being used
  • Minimal reproduction steps

Creating issues for features

Use your best judgement on what is needed here.

Pull requests

Create pull requests to the master branch.

Pull requests for bugs

If possible provide:

  • Code that fixes the bug
  • Failing tests which pass with the new changes
  • Improvements to documentation to make it less likely that others will run into issues (if relevant).

Pull requests for features

If possible provide:

  • Code that implements the new feature
  • Tests to cover the new feature including all of the code paths
  • Docstrings for functions
  • Documentation examples