When contributing to this repository, please first search through the issues in the repository and commit "assign me" if you wish to work on that , then owners of this repository will let you know by latest by assigning you the issue.
Please note we have a code of conduct, please follow it in all your interactions with the project.
- [Prerequisite tools (e.g., Git, Node.js >=19, PNPM)] installed.
- Forked and cloned this repository.
- Run
pnpm installin the root directory to install dependencies.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
- Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
Project maintainers are responsible for:
- Providing guidance to contributors
- Maintaining repository quality and standards
- Setting clear expectations for contributions
Contributors are expected to follow maintainer guidance and project guidelines.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
- Project Link: GitHub Repository
- Discord: Discord
Engineered with ❤️ by the Plura Team