This document describes how to contribute to the project. Please refer to the README.md
file for information on how to build and setup the development environment.
The project's source code is hosted on GitHub. In development, work is submitted via Pull Request (PR) and merged to the dev branch after passing review. From time-to-time work will be collected and packaged into a release. A production site can be deployed based off of a production branch, which will merge in releases from dev. If necessary a staging branch can be setup to deploy a staging site and test changes before adding them to the production site.
Standard Laravel practices should be followed, and more specifically Spatie's style guidelines have been adopted into the codebase where possible.
Additionally tools have been provided to help manage the code styling. Before submitting a PR make sure to run the all of the linting and formatting tasks as defined in the Linting section of the README.
New features and bug fixes should be accompanied by tests where possible. Where possible tests should be written using PEST.
Commit logs should follow the Conventional Commits spec.
Contributions should be submitted by a Pull Request (PR) to the dev branch, and associated with a related issue. After being approved by a maintainer it will be squash merged into the dev branch.