github-com-docker-mailserver/docker-mailserver
1
0
Fork 0
mirror of https://github.com/docker-mailserver/docker-mailserver.git synced 2024-01-19 02:48:50 +00:00
Code Issues Projects Releases Wiki Activity

Added detail on development workflow

Browse source
This commit is contained in:
Thomas VIAL 2017-01-19 13:31:04 +01:00
parent 3bd07af462
commit 480113901e
No known key found for this signature in database
GPG key ID: 0394CEE552FAFEFC
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
CONTRIBUTING.md
View file

@ -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 ├── target # Developer: default server configuration, used when building the image
└── test # Developer: integration tests to check that everything keeps working └── 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: The development workflow is the following:
@ -24,9 +26,10 @@ The development workflow is the following:
- Code :-) - Code :-)
- Add integration tests in `test/tests.bats` - Add integration tests in `test/tests.bats`
- Use `make` to build image locally and run tests - 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 - [Commit](https://help.github.com/articles/closing-issues-via-commit-messages/), push and make a pull-request
- Pull-request is automatically tested on Travis - 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 - `master` is automatically tested on Travis
- Docker builds a new `latest` image - Docker builds a new `latest` image