From ddd6ed65bb41cb164489ec416ca1dee65c855137 Mon Sep 17 00:00:00 2001 From: Lakindu Akash Date: Tue, 13 Oct 2020 16:40:37 +0530 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dfc7ac8..a1059cb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,16 @@ -## Contributing +# Contributing -This project is still new. So you can simply open a issue and send a PR. Also there are some existing issues. Pick one and start contributing. +When contributing to this repository, please first discuss the change you wish to make via issue, +gitter channel 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. + +## 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 + 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/). +4. Once code will be reviewed and tested PR will be merged. Also make sure to fix any automated build and test errors if any.