Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

50 lines (31 loc) · 1.98 KB

Contributing Guidelines

The following is a set of guidelines, not rules, for contributing to this project.

Issue Guidelines

  • Do not open duplicate issues.
  • Provide enough information for the issue to be workable.

Bug Report

  • A concise description of the bug report. What exactly is wrong and why?
  • The actual behaviour. What really happened here? If you have a traceback, this is where you'd put it.
  • The expected behavior. What did you expect to happen here? What is different?
  • Easy-to-follow reproduction steps. Why did this happen?
  • Any additional context. Do you have anything to add to this?
  • The checklist. All of the boxes should be checked before you open the issue.
  • Your system information. Contributors may need to know your system information to reproduce this issue.

Feature Request

  • A concise description. What made you want to open this issue?
  • The current solution. Is there an alternative?
  • The ideal solution. This part separates an issue from a pull request, you write this in English, not code.
  • Any additional context. Do you have anything to add to this?
  • The checklist. All of the boxes should be checked before you open the issue.

Pull Request Guidelines

  • Do not open duplicate pull requests.

  • Try to focus on a single aspect -- If another pull request is necessary, create one.

  • Try to follow the language's guidelines; for example, Python's PEP-8.

  • Please remember to test your PR before you mark it as ready for review.

  • A concise description. What does this PR do?

  • The checklist. All of the boxes should be checked before you mark the pull request as ready for review.

Commit Guidelines

  • Use the imperative mood. (implement ... not implemented ...)
  • Reference issues and pull requests outside of the first line.