Skip to content

Latest commit

 

History

History
39 lines (23 loc) · 2.36 KB

CONTRIBUTING.markdown

File metadata and controls

39 lines (23 loc) · 2.36 KB
Raw

How to Contribute

You can help this project by sending feature requests, bug reports, patches, or merge requests. All communication and contributions are expected to follow our project's Code of Conduct.

Our Issue Tracker is hosted on GitHub.

Feature Requests

If you have an idea for a feature or way for the dashboard to be improved, you can add it to the project's Issue Tracker.

  1. First check the Issue Tracker for any existing feature requests that match yours. If it exists, you can add a comment or vote to note your interest.
  2. If an existing issue doesn't exist, create a new one for the "Simple STA Dashboard" project.
  3. For a Feature Request, I recommend you use the "Task" or "Story" issue type. Then fill in the remaining fields that make sense to you.
  4. Once you submit the issue, the project team will review it and work with you to fit it in the project scope and schedule.

Bug Reports

If you found an unexpected or unwanted behaviour in the dashboard, please report it on the project's Issue Tracker.

  1. First check the Issue Tracker for any existing bug reports that match yours. If it exists, you can add a comment or vote to note your interest.
  2. If an existing bug report doesn't exist, create a new one for the "Simple STA Dashboard" project.
  3. For a Bug Report, use the "Bug" issue type. Then fill in the remaining fields that make sense to you.
  4. Once you submit the issue, the project team will review it and work with you to narrow down the cause and find a fix.

Patches/Merge Requests

If you found a bug in the code and want to submit a fix or change, you can either email the patch to the development team or send a Pull Request.

Note that you should contact the development team before writing the patch to confirm that nobody else is already working on it and to discuss when the patch will be released.

Documentation Contributions

Updates to any documentation are very welcome. Please follow the Patches/Merge Requests guidelines above to submit either new documentation or changes to existing documentation. Grammar and spelling fixes are welcome, even small ones.

Thanks for looking at our contribution guide!

— Dev Team