Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.21 KB
Raw

Contributing to clj-rethinkdb

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

The following is a set of guidelines for contributing to clj-rethinkdb 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:

  • RethinkDB version
  • Version of clj-rethinkdb being used
  • Minimal reproduction steps

Creating issues for features

Use your best judgement on what is needed here.

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).
  • Add the change to the Unreleased section of CHANGELOG.md

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
  • Add the change to the Unreleased section of CHANGELOG.md