diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bab32ec..d5601c2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. -- 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. -- 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 describe your needs so we can discuss whether this feature should be added to Gomail or not. diff --git a/README.md b/README.md index f1e2e9a..2dfe096 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,8 @@ Note, however, that this is insecure and should not be used in production. ## Contribute -See [CONTRIBUTING.md](CONTRIBUTING.md). +Contributions are more than welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for +more info. ## Change log