Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 1.7 KB

Contribution guidelines.

Looking to contibute something to this repository? Here's how you can help.

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect of time of the developer(s) managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

Using the issue tracker

The issue tracker is preferred for bug reports, features requests and submitting pull requests, but please respect the following restrictions:

  • Please do not use the issue tracker for personal support requests.
  • Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.
  • Please do not open issues of pull requests regarding the code of other packages. (Open them in their respective repositories)

Bug reports

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful, so thanks!

Guidelines for bug reports;

  1. Validate and lint your code.
  2. Use the github search.
  3. Check if the issue has been fixed.
  4. Isolate the problem.

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? Do other browsers show the bug differently? What would you expect to be the outcome? All these details will help people to fix any potential bugs.