Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

18 lines (13 loc) · 1.69 KB

Contributions are welcome but please adhere to some basic guidelines, outlined below.

  • Line endings - As this script is written in PowerShell, and intended for use on Microsoft Windows, please ensure files use the standard Microsoft line ending of carriage return and line feed (\r\n).
  • Test your code - It's important to ensure what you're attempting to commit doesn't fundamentally break the script, so please test it.
  • Commit messages - For continuity, please don't include a full stop (period) at the end of your commit messages first line. I'm told omitting the period is fairly standard practice and this ties in with other projects.
  • Reference issues where appropriate - When working on something that relates to an issue, please comment on the issue to avoid duplicated effort. Please also reference the issue in a commit or PR for clarification.

Contributing code

If you spot an improvement you're able to make, please fork the project and submit a Pull Request (PR). PRs will be reviewed as time allows and may be merged as appropriate but there is no guarantee your PR will be accepted. Please don't take offence if that's the case, I'm happy to discuss the PR and hope we can come to a happy medium.

Contributing documentation

There is a wiki for this project, where most documentation can be found. Corrections and amendments would be gratefully received.

Translations

If you'd like to translate the wiki that'd be great. Thanks in advance.

Reporting issues

Bugs are a fact of a developer's life so if you find a bug please raise an issue. Issues will be reviewed as time allows, however, if you're able to submit a fix your contribution would be more than welcome.