From 8a81f4ad6f7d5bcc51d283faecf54c338e84abb4 Mon Sep 17 00:00:00 2001 From: Alexandre Cesaro Date: Mon, 20 Jul 2015 23:18:34 +0200 Subject: [PATCH] Added CONTRIBUTING.md --- CONTRIBUTING.md | 10 ++++++++++ README.md | 12 +++++++----- 2 files changed, 17 insertions(+), 5 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..bab32ec --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,10 @@ +Contributions are more than welcome: + +- 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 +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 +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 b6f45c1..0c970ec 100644 --- a/README.md +++ b/README.md @@ -74,11 +74,13 @@ bypass the verification of the server's certificate chain and host name by using Note, however, that this is insecure and should not be used in production. +## Contribute + +See [CONTRIBUTING.md](CONTRIBUTING.md). + + ## Contact -You are more than welcome to open issues and send pull requests if you find a -bug or need a new feature. - -You can also ask questions on the [Gomail +You can ask questions on the [Gomail thread](https://groups.google.com/d/topic/golang-nuts/ywPpNlmSt6U/discussion) -in the Go mailing-list or via Twitter [@alexandrecesaro](https://twitter.com/alexandrecesaro). +in the Go mailing-list.