Updated CONTRIBUTING.md

This commit is contained in:
Alexandre Cesaro 2015-07-26 18:12:39 +02:00
parent 9990d7c9fb
commit 629d36f9e2
2 changed files with 16 additions and 5 deletions

View File

@ -1,10 +1,20 @@
Contributions are more than welcome: Thank you for contributing to Gomail! Here are a few guidelines:
- If you think you found a bug, create an issue and supply the minimum amount ## Bugs
If you think you found a bug, create an issue and supply the minimum amount
of code triggering the bug so it can be reproduced. of code triggering the bug so it can be reproduced.
- If you want to fix a bug, you can send a pull request. It should contains a
## Fixing a bug
If you want to fix a bug, you can send a pull request. It should contains a
new test or update an existing one to cover that bug. new test or update an existing one to cover that bug.
- If you think Gomail lacks a feature, you can open an issue or send a pull
## New feature proposal
If you think Gomail lacks a feature, you can open an issue or send a pull
request. I want to keep Gomail code and API as simple as possible so please request. I want to keep Gomail code and API as simple as possible so please
describe your needs so we can discuss whether this feature should be added to describe your needs so we can discuss whether this feature should be added to
Gomail or not. Gomail or not.

View File

@ -56,7 +56,8 @@ Note, however, that this is insecure and should not be used in production.
## Contribute ## Contribute
See [CONTRIBUTING.md](CONTRIBUTING.md). Contributions are more than welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for
more info.
## Change log ## Change log