Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.54 KB

contributing.md

File metadata and controls

34 lines (25 loc) · 1.54 KB
Raw

Contributing

Bug reports

Keep bug reports short but descriptive. Include all details that are relevant and what the expected outcome should be.

Example:

Short and descriptive example bug report title

A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

  1. This is the first step
  2. This is the second step
  3. Further steps, etc.

<url> - a link to the reduced test case

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

Pull requests

Contributions to this repository are welcomed. Please ensure your pull requests adhere to the following guidelines:

  • Make individual pull requests for each of your suggested changes.
  • Code (including comments) and documentation should be in English. Check spelling and grammar.
  • Make sure you lint your code before committing.
  • Add an entry in CHANGELOG.md describing your changes.
  • Rebase your branch on main or merge the main branch into your branch before opening a pull request.
  • Include a clear title and description.

Feature requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.