Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

35 lines (22 loc) · 2.19 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.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Branch naming convention

Instance Branch Name Description
Stable main Accepts merges from Working and Hotfixes
Working dev Accepts merges from Features/Issues and Hotfixes
Feature/Issue feature/ - fix/ Always branch off HEAD of Working
Hotfix hotfix/ Always branch off Stable

Merge Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Update the README.md with details of changes to the interface, this includes new 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 Merge Request would represent. The versioning scheme we use is SemVer.
  4. You may merge the Merge Request in once you have the sign-off of another developer, or if you do not have permission to do that, you may request the reviewer to merge it for you.

Be careful, do not squash multiple commits into one, we prefer to have the full commit history of our codebase.

Code of Conduct

Our Pledge

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available here.