First of all, thank you for reading this file, as it means you're interested in helping out with this project. Anyone is invited to propose changes, fixes, and new features through pull requests in this repository. The following guidelines are intended to keep the commit history clean and easy to read.
You can run the included unit tests by installing busted and running busted . in the project root.
We use luacheck for linting, just run luacheck src tests in the project root.
busted and luacheck will be automatically run for your pull requests.
If you install luacov, you can run the tests with coverage analysis enabled (busted -c .). This will generate a stats file which can be turned into a coverage report by running luacov in the project root.
Please create a pull request with a clear explanation of what you've done (read more about pull requests).
Use the develop branch as the base for your PR.
Rebase your PR branch into as few commits as possible. Rebasing is encouraged to help keep a linear commit history.
This repository generally follows the Chris Beams standards for commit messages:
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
Please ensure you've followed the above guidelines for your commit messages.
Thanks again and I look forward to reviewing your work.