Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

28 lines (20 loc) · 1.71 KB
Raw

Contributing to this project

Contributions to this project are welcome. Please take a moment to read this document, in order to make the contribution process easier for everyone involved.

Bug Reports

  • Before opening a bug report, please use the Github issue search to check if the issue has already been reported.
  • When you are creating a bug report, please include as many details as possible: expected vs. observed behavior, steps to reproduce, a description of your environment.

Feature Requests

Feature requests are welcome. But do take a moment to find out whether your idea fits with the scope and aims of the project. Please provide as much detail and context as possible.

Pull Requests

Pull requests are very welcome — be they bug fixes, improvements or new features. Before embarking on a significant pull request, please first discuss the change you wish to make with the owners of this repository, by creating an issue.

If you are not familiar with the Github contributing process, you can take a look at this guide.

Please make sure your PRs:

  • Pass all tests (and — in case of new features — add appropriate tests).
  • Adhere to the coding conventions used throughout the project.
  • Include as few commits as possible, with clear commit messages, avoiding mixing code changes with whitespace cleanup.
  • Are limited to a single feature/issue.
  • Have a clear title and description.
  • Have you included in AUTHORS.

☝️ By submitting work for inclusion to this project, you agree to allow the project owner to license your work under the same license as that used by the project.

Thank you! ❤️

Convert Group Developers