From 49b62aa1be6bb15706d28b6e6289d01a67b7e745 Mon Sep 17 00:00:00 2001 From: Thomas VIAL Date: Sat, 24 Dec 2016 14:52:00 +0100 Subject: [PATCH] Fixes #423 (#428) --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..e1b107ad --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# Contributing + +`docker-mailserver` is OpenSource. That means that you can contribute on enhancements, bug fixing or improving the documentation in the Wiki. + +## Open an issue + +When opening an issue, please provide details use case to let the community reproduce your problem. +Please start the mail server with env `DMS_DEBUG=1` and paste the ouput into the issue. + +## Pull Requests + +#### Project architecture + + ├── config # User: personal configurations + ├── target # Developer: default server configuration, used when building the image + └── test # Developer: integration tests to check that everything keeps working + +#### Development Workflow + +The development workflow is the following: + +- Fork project and clone your fork +- Create a branch using `git checkout -b branch_name` (you can use `issue-xxx` if fixing an existing issue) +- Code :-) +- Add integration tests in `test/tests.bats` +- Use `make` to build image locally and run tests +- Document your improvements +- [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` +- `master` is automatically tested on Travis +- Docker builds a new `latest` image