add contribution guidelines and maintainers

nuvo · Dec 30, 2018 · 665584c · 665584c
1 parent c18eca9
commit 665584c
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,10 @@
+# Contributing
+
+Nuvo uses GitHub to manage reviews of pull requests.
+
+* If you have a trivial fix or improvement, go ahead and create a pull request, addressing (with `@...`) the maintainer of this repository (see [MAINTAINERS.md](./MAINTAINERS.md)) in the description of the pull request.
+
+* If you plan to do something more involved, please reach out first to one of the maintenrs to discuss your ideas, in order to avoid unnecessary work and surely give you and us a good deal of inspiration.
+
+* Relevant coding style guidelines are the [Go Code Review Comments](https://code.google.com/p/go-wiki/wiki/CodeReviewComments)
+  and the _Formatting and style_ section of Peter Bourgon's [Go: Best Practices for Production Environments](http://peter.bourgon.org/go-in-production/#formatting-and-style).
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -0,0 +1 @@
+* Maor Friedman <maor.friedman@nuvocares.com>