2019-09-27 17:30:23 +00:00
|
|
|
# Contributing
|
2019-08-21 13:18:20 +00:00
|
|
|
|
2019-09-27 17:30:23 +00:00
|
|
|
When contributing to this repository, please first discuss the change you wish to make via issue,
|
2019-11-25 15:15:13 +00:00
|
|
|
email, or any other method with the owners of this repository before making a change.
|
2019-08-21 13:18:20 +00:00
|
|
|
|
2019-09-27 17:30:23 +00:00
|
|
|
Please note we have a code of conduct, please follow it in all your interactions with the project.
|
2019-08-21 13:18:20 +00:00
|
|
|
|
2019-09-27 17:30:23 +00:00
|
|
|
## Pull Request Process
|
2019-08-21 13:18:20 +00:00
|
|
|
|
2019-11-25 15:15:13 +00:00
|
|
|
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
|
2019-09-27 17:30:23 +00:00
|
|
|
build.
|
2019-11-25 15:15:13 +00:00
|
|
|
2. Update the README.md with details of changes to the interface, this includes new environment
|
2019-09-27 17:30:23 +00:00
|
|
|
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
|
2021-04-23 11:38:17 +00:00
|
|
|
Pull Request would represent. The versioning scheme we use is [SemVer](https://semver.org).
|
2019-11-25 15:15:13 +00:00
|
|
|
4. You may merge the Pull Request 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 merge it for you.
|
