Merge pull request #12 from dimitern/v1-contrib

Added contributing instructions, ways to get in touch, and list of authors.

AUTHORS.md

@@ -0,0 +1,23 @@
+goamz Authors
+=============
+
+This file contains a list of people who contributed relevant code to the project.
+
+Anyone with knowledge of Amazon Web Services API who wants to get
+involved in the project maintenance, code reviews, issues triage, and
+helping goamz users and community members in general, please consider
+contacting one of the project's [maintainers](https://github.com/orgs/go-amz/people) and request to become one. Check [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+Please, keep the list sorted.
+
+Full name | E-mail | GitHub account
+----------|--------|---------------
+Andrew Wilkins | andrew.wilkins {at} canonical.com | [@axw](http://github.com/axw)
+Dave Cheney | dave.cheney {at} canonical.com | [@davecheney](http://github.com/davecheney)
+Dimiter Naydenov | dimiter.naydenov {at} canonical.com | [@dimitern](http://github.com/dimitern)
+Francisco Souza | f {at} souza.cc | [@fsouza](https://github.com/fsouza)
+Gustavo Niemeyer | gustavo.niemeyer {at} canonical.com | [@niemeyer](http://github.com/niemeyer) (project founder)
+Ian Booth | ian.booth {at} canonical.com | [@wallyworld](http://github.com/wallyworld)
+Katherine Cox-Buday | katherine.cox-buday {at} canonical.com | [@katco-](http://github.com/katco-)
+Martin Packman | martin.packman {at} canonical.com | [@bz2](http://github.com/bz2)
+Roger Peppe | roger.peppe {at} canonical.com | [@rogpeppe](http://github.com/rogpeppe)

CONTRIBUTING.md

@@ -0,0 +1,93 @@
+Contributing to goamz
+=====================
+
+We encourage everyone who is familiar with the [Amazon Web Services
+API](http://aws.amazon.com/documentation/) and is willing to support
+and improve the project to become a contributor. Current list of
+official maintainers can be found on the [go-amz People](https://github.com/orgs/go-amz/people) list. Current and past contributors list is in the [AUTHORS.md](AUTHORS.md) file.
+
+This file contains instructions and guidelines for contributors.
+
+Code of conduct
+---------------
+
+We are committed to providing a friendly, safe and welcoming environment
+for all users and community members. Please, review the [Ubuntu Code of Conduct](https://launchpad.net/codeofconduct/1.1),
+which covers the most important aspects we expect from contributors:
+
+ * Be considerate - treat others nicely, everybody can provide valuable contributions.
+ * Be respectful of others, even if you don't agree with them. Keep an open mind.
+ * Be collaborative - this is essential in an open source community.
+ * When we disagree, we consult others - it's important to solve disagreements constructively.
+ * When unsure, ask for help.
+ * Step down considerately - if you need to leave the project, minimize disruption.
+
+Ways to contribute
+------------------
+
+There are several ways to contribute to the project:
+
+ * Join the [goamz Google Group](https://groups.google.com/forum/#!forum/goamz) to ask questions and get help.
+ * Report [issues](https://github.com/go-amz/amz/issues/new) you might have. Please, make sure there is no existing [known issue](https://github.com/go-amz/amz/issues) when reporting a new one.
+ * Propose a patch or a bug fix by opening a [pull request](https://help.github.com/articles/creating-a-pull-request/). Check GitHub help on [how to collaborate](https://help.github.com/categories/collaborating/).
+ * Give feedback for [known issues](https://github.com/go-amz/amz/issues/) or proposed [pull requests](https://github.com/go-amz/amz/pulls).
+
+For some of those things you will need a [GitHub account](https://github.com/signup/free), if you don't have one.
+
+Contributing a patch
+--------------------
+
+Found a bug or want to suggest an improvement?
+Great! Here are the steps anyone can follow to propose a bug fix or patch.
+
+ * [Fork](https://help.github.com/articles/fork-a-repo/) the go-amz/amz repository.
+ * If you think you found a bug, please check the existing [issues](https://github.com/go-amz/amz/issues) to see if it's a known problem. Otherwise, [open a new issue](https://github.com/go-amz/amz/issues/new) for it.
+ * Clone your forked repository locally:
+```
+$ git clone https://github.com/<your-github-username>/amz
+```
+ * For the unit tests, you will need [gocheck](https://github.com/go-check/check):
+```
+$ go get gopkg.in/check.v1
+```
+ * Create a feature branch for your contribution. Make your changes there. It's recommended to try keeping your changes as small as possible. Split bigger changes in several pull request to make the code review easier.
+ * Be sure to write tests for your code changes and run them before proposing:
+```
+$ go test -gocheck.v
+```
+ * Push your feature branch to your fork.
+ * Open a pull request with a description of your change.
+ * A maintainer should notice your pull request and do a code review. You can also ask a [maintainer](https://github.com/orgs/go-amz/people) for review.
+ * Reply to comments, fix issues, push your changes. Depending on the size of the patch, this process can be repeated a few times.
+ * Once you get an approval and the CI tests pass, ask a maintainer to merge your patch.
+
+Becoming an official maintainer
+-------------------------------
+
+Thanks for considering becoming a maintainer of goamz! It's not
+required to be a maintainer to contribute, but if you find yourself
+frequently proposing patches and can dedicate some of your time to
+help, please consider following the following procedure.
+
+ * You need a [GitHub account](https://github.com/signup/free) if you don't have one.
+ * Review and sign the Canonical [Contributor License Agreement](http://www.ubuntu.com/legal/contributors/). You might find the [CLA FAQ](http://www.ubuntu.com/legal/contributors/licence-agreement-faq) page useful.
+ * Request to become a maintainer by contacting the [existing maintainers](https://github.com/orgs/go-amz/people).
+ * You're welcome to add your name to the [AUTHORS.md](AUTHORS.md) list once approved.
+
+General guidelines
+------------------
+
+The following list is not exhaustive or in any particular order. It
+providers things to keep in mind when contributing to goamz. Be
+reasonable and considerate and please ask for help, if something is
+not clear.
+
+ * Commit early, commit often.
+ * Use `git rebase` before proposing your changes to squash minor commits. Let's keep the commit log cleaner.
+ * **Do not** rebase commits you already pushed, even when in your own fork. Others might depend on them.
+ * Write new tests and update existing ones when changing the code. All changes should have tests, when possible.
+ * Use `go fmt` to format your code before pushing.
+ * Document exported types, functions, etc. See the excellent [Effective Go](http://golang.org/doc/effective_go.html) style guide, which we use.
+ * When reporting issues, provide the necessary information to reproduce the issue.
+
+Thanks for your interest in goamz!

README.md

@@ -3,7 +3,7 @@ goamz
 
 Go package to interact with Amazon Web Services
 
-[![Build Status](https://travis-ci.org/go-amz/amz.svg)](https://travis-ci.org/go-amz/amz)
+[![Build Status](https://travis-ci.org/go-amz/amz.svg)](https://travis-ci.org/go-amz/amz) [![GoDoc](https://godoc.org/gopkg.in/amz.v1?status.png)](http://godoc.org/gopkg.in/amz.v1)
 
 Instructions
 ------------
@@ -30,3 +30,30 @@ For more details, visit the project page:
 and the API documentation:
 
 * https://gopkg.in/amz.v1
+
+Users Group
+-----------
+
+In addition to contacting directly one of the [maintainers](https://github.com/orgs/go-amz/people), users are encouraged to discuss goamz topics on the project's [Google Group](https://groups.google.com/forum/#!forum/goamz).
+
+Issues
+------
+
+Please report bugs by opening an [issue](https://github.com/go-amz/amz/issues).
+
+Contributing
+------------
+
+Contributors are most welcome!
+Please have a look at [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+Authors
+-------
+
+List of people who made relevant contributions to goamz can be found in [AUTHORS.md](AUTHORS.md).
+
+License
+-------
+
+goamz is licensed under LGPLv3, but includes an exception that allows
+linking code statically. See the [LICENSE](LICENSE) for details.