Below provides an overview of guidelines for contributing to this project. We are continuing to improve our standards and guidelines as the project matures so feedback is always welcome.
We have established Code of Conduct guidelines for creating an inclusive environment to contribute to this project.
We are using ShellCheck to lint this script. Our ShellCheck rule configuration could do with some improvement so feedback is definitely welcome. We have the extension setup for making use of GitHub Codespaces, but aren't running the linter as part of a GitHub Action (would be open to have this setting up as well once rules are in place).
We treat commit messaging as part of our documentation to describe the evolution and rationale of how this project is in its current state. Therefore we follow these Commit Messaging Guidelines which can be summarised as:
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- Wrap the body at 72 characters
- Use the body to explain what and why vs. how
We will ask for commit messages to be refactored in pull requests if it doesn't meet these guidelines.