1
0
mirror of https://github.com/tomav/docker-mailserver.git synced 2024-06-26 09:09:23 +02:00

Updated How to contribute (markdown)

This commit is contained in:
Thomas VIAL 2016-04-27 23:54:08 +02:00
parent d373185c1d
commit e7f16f56f0

View File

@ -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