1.7 KiB
Contributing to this project
Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
Using the issue tracker
The issue tracker is the preferred channel for bug reports and features requests, but please respect the following restrictions:
-
Please do not use the issue tracker for personal support requests.
-
Please keep the discussion on topic and respect the opinions of others.
Bug reports
A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!
Guidelines for bug reports:
-
Use the GitHub issue search — check if the issue has already been reported.
-
Check if the issue has been fixed — try to reproduce it using the latest branch in the repository.
-
Isolate the problem — create a reduced test case and a live example.
A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.
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.