Contributions are welcome. What is expected from contributors is outlined below. If at any stage you require help, please just ask!
If there is something specific you want to work on, then please open an issue/discussion first to avoid duplication of efforts. Then:
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Make your changes
- Review the steps below before committing your changes
- Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Ensure that the README.md is updated where changed due to the new feature.
Any new or changed functions and module level locals should be annotated with Lua specs. These not only provide documentation but also assist the Language Server with completion and signature information. You can learn more about Lua annotations here.
Tests should be added to cover any changes or new features. These can be found in the tests folder. To run the tests, Make is required. Run make test from the repository root.
This project uses StyLua to ensure consistent code formatting.
The StyLua documentation details a number of ways this tool can be installed, including an executable you can just download. Then from the root of this repository run stylua -g **/*.lua (or stylua -g **\*.lua if on Windows).
Please run StyLua before committing your code. Do not commit the StyLua executable to this repository.
This project uses Luacheck for static analysis and linting of the code.
The CI system used by this repository will run the tests, check the code formatting with Stylua, and lint the code with Luacheck. These checks must pass before a pull request can be merged, so performing these tasks locally first before committing will avoid having to push fix up commits.
Please use the Conventional Commits Specification when writing your commit messages.