From e7f16f56f0f7b577b5f0f4fe8f9314ed9b7eb15c Mon Sep 17 00:00:00 2001 From: Thomas VIAL Date: Wed, 27 Apr 2016 23:54:08 +0200 Subject: [PATCH] Updated How to contribute (markdown) --- docs/content/how-to-contribute.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/docs/content/how-to-contribute.md b/docs/content/how-to-contribute.md index 29efe8cc..cab31ffa 100644 --- a/docs/content/how-to-contribute.md +++ b/docs/content/how-to-contribute.md @@ -1,14 +1,21 @@ -Contribution is like any other GitHub project: - -- Fork -- Improve -- Add integration tests in `test/tests.bats` -- Build image and run tests using `make` -- Document your improvements -- Commit, push and make a pull-request +`docker-mailserver` is OpenSource. That means that you can contribute on enhancements, bug fixing or improving the documentation in the Wiki. #### Project architecture ├── config # User: personal configurations ├── target # Developer: default server configurations └── test # Developer: integration tests + +#### Development Workflow + +When `v2` will be released, the development workflow will be: + +- Fork +- Improve +- Add integration tests in `test/tests.bats` +- Use `make` to build image locally and run tests +- Document your improvements +- Commit, push and make a pull-request on `develop` branch +- When tests are green, your branch is merged and tested on real servers by contributors +- When feedback is positive, develop is merged on master +