Contributions are welcomed and the following text serves as a set of guidelines for contributing to the project. These are not strict rules, so use your best judgement and feel free to propose changes to this document with a pull request.
By participating in the project you are expected to uphold the Code of Conduct. Please report instances of unacceptable behaviour to marc.ransome@fidgetbox.co.uk.
- Start your commit message with a capital letter and omit the trailing period
- Use the imperative mood in your commit message such as "Fix bug" and not "Fixed bug"
- Limit the first line of your message to 72 characters or less
- Use a single blank line to separate your commit message from any additional body text
- Split longer message bodies into paragraphs separated by a single blank line
- Reference any issue(s) or pull request(s) in the body of your message not the summary
Consistency makes maintaining and extending the codebase easier and can encourage others to contribute. Consider the following points when making code changes:
- Use 4-space indents not tabs
- Use UNIX line endings (
LF) in all files - Use descriptive function and variable names
- Avoid code comments unless used to clarify something that is not otherwise obvious