contributing.md

You may contribute to this project via issues and pull requests.

Issues

If you are reporting an issue, please click the links below and your issue will be prefilled with our template. You need to replace the parts of the template where you see {{some text}}.

• [Problem](../../issues/new?title={{Brief description of your bug}}&body=Version%0A{{branch}} at {{commit}}%0A%0ASteps to reproduce the bug%0A{{steps}}%0A%0AExpected behaviour%0A{{feature}} should be {{expectedResult}} because {{reason}}.%0A%0AActual behaviour%0A{{feature}} is {{actualResult}}.%0A%0AAdditional information%0A{{additionalInfo}}): reports a feature that is not working as expected.
• [Enhancement](../../issues/new?title={{Brief description of your enhancement}}&body=Motive%0A{{why the enhancement is needed}}%0A%0AResult%0A{{what the enhancement is}}%0A%0AAdditional information%0A{{additionalInfo}}): requests removal, addition, or change of a feature.
• [Question](../../issues/new?title={{Brief description of your question}}&body={{question}}%3F): asks how a feature should be used or what a feature does.

Pull Requests

A PR must be in response to an issue and must reference the issue in the description of the pull request.

1. Open the file you wish to edit on Github.
2. Edit the file.
3. Enter a "commit message" (found below the edited file).
4. Click "Propose file changes" (found below the edited file).

Collaborators

Collaborators (users that have write access to the repository) should assign a collaborator to maintain issues (or pull requests) and one label from each of the three sections below.

• Priority
  • High
  • Medium
  • Low
• Type
  • Bug
  • Enhancement
  • Question
• Status
  • Unconfirmed (reported but not been reproduced)
  • Confirmed (been reproduced but not fixed)
  • Unmerged (been fixed but not merged/tested)

If a pull request references the issue then work has started, if the issue is closed then it should be considered to be resolved.