Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 1.89 KB

Contribution to Empyrean

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 and 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 version of Empyrean you are using
  • The version of Python you are using
  • The operating system you are using
  • The steps to reproduce the bug
  • The expected behaviour
  • The actual behaviour
  • Any error messages

Pull Requests

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

Please ensure your pull request adheres to the following guidelines:

  • It doest dramatically change core functionality
  • It does not break existing functionality
  • It doesnt contain any self-promotion or advertising
  • It is not pointless
  • It follows a similar style to the rest of the project