From 480113901e512f658240f68e471cb4ffedafb86e Mon Sep 17 00:00:00 2001 From: Thomas VIAL Date: Thu, 19 Jan 2017 13:31:04 +0100 Subject: [PATCH] Added detail on development workflow --- CONTRIBUTING.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e1b107ad..41768cfd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,9 @@ Please start the mail server with env `DMS_DEBUG=1` and paste the ouput into the ├── target # Developer: default server configuration, used when building the image └── test # Developer: integration tests to check that everything keeps working -#### Development Workflow +#### Submit a Pull-Request + +You want to add a feature? Feel free to start creating an issue explaining what you want to do and how you're thinking doing it. Other users may have the same need and collaboration may lead to better results. The development workflow is the following: @@ -24,9 +26,10 @@ The development workflow is the following: - Code :-) - Add integration tests in `test/tests.bats` - Use `make` to build image locally and run tests -- Document your improvements +- Document your improvements in `README.md` or Wiki depending on content - [Commit](https://help.github.com/articles/closing-issues-via-commit-messages/), push and make a pull-request - Pull-request is automatically tested on Travis -- When tests are green, your branch is merged into `master` +- When tests are green, a review may be done +- When changed are validated, your branch is merged into `master` - `master` is automatically tested on Travis - Docker builds a new `latest` image