From f1e03a304520c4e0cb801d3b625979227ee84a78 Mon Sep 17 00:00:00 2001 From: Quentin Manfroi Date: Wed, 27 Nov 2019 16:23:42 +0100 Subject: [PATCH] MON-519 Apply suggestion to CONTRIBUTING.md --- CONTRIBUTING.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index af39bed..8c1d90d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,7 @@ 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. +Please note we have a [code of conduct](#code-of-conduct), follow it in all your interactions with the project. ## Considerations @@ -17,9 +17,8 @@ Please note we have a code of conduct, please follow it in all your interactions ## Pull 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 +1. Ensure to run the `auto_update.sh` script to be in an up to date and valid state. +2. Update the main 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 Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).