docs: add CONTRIBUTING doc

This commit is contained in:
Ricardo Arturo Cabral Mejia 2022-10-21 17:59:08 -04:00
parent c45c02ca61
commit 3f102b15b6
No known key found for this signature in database
GPG Key ID: 5931EBF43A650245

16
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,16 @@
# 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 keep the conversations civil, respectful and focus on the topic being discussed.
## Pull Request Process
1. Update the relevant documentation with details of changes to the interface, this includes new environment
variables, exposed ports, useful file locations and container parameters.
2. 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](http://semver.org/).
3. 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.