Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

42 lines (26 loc) · 1.69 KB

Contributing to skuld

Feature Requests

A feature request is a request for a new feature or an enhancement to an existing feature.

Generally features are requested through the use of the feature request template.

Ensure you do not create a duplicate feature request by searching through the existing feature requests.

Please give detailed information about the feature you are requesting in order for it to be best implemented.

Note that feature requests are not guaranteed to be implemented.

Bug Reports

A bug report is a report of a bug or issue in the software.

Generally bugs are reported through the use of the bug report template

Ensure you do not create a duplicate bug report by searching through the existing bug reports.

Please make sure to include as much information as possible in your bug report. This includes:

  • The expected behaviour
  • The actual behaviour
  • The steps to reproduce the bug
  • Any error messages
  • Go version
  • Windows version
  • Module name
  • Version of the app you are using the module on (if applicable)

Pull Requests

A pull request is a request to add your own code to the project therefore solving an issue or adding a feature.

Generally pull requests are submitted through the use of the pull request template.

Please ensure your pull request adheres to the following guidelines:

  • It does not break existing functionality
  • It follows a similar style to the rest of the project