Skip to content

Latest commit

 

History

History
26 lines (17 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

26 lines (17 loc) · 1.48 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Welcome to our community. Please follow our Code of Conduct in all of your interactions with the project.

Commits messages

This project follows Conventional Commits format for commit messages and implements it through the pre-commit framework. You must install and enable pre-commit before you can contribute to the project.

Pull Request Process

  1. To install and enable the pre-commit framework, run the pre-commit install command.
  2. Update the project README.md with details of interface changes, including new or changed environment variables, exposed ports, useful file locations, and container parameters.
  3. 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.
  4. Pull Requests can be merged after they have approvals of one other developer. If you do not have merge permissions, request the second reviewer to merge the PR for you.

When making comments against a PR, be sure to follow the recommendations in Conventional Comments.

Code of Conduct

See Code of Conduct.