Permalink
Browse files

adding CONTRIBUTING and _FOR COMMITTERS pages

  • Loading branch information...
1 parent 7979e61 commit 201bd159def1dd45c27ed1b2fda8baaefc72e6a1 @gwaldo gwaldo committed Apr 12, 2016
Showing with 52 additions and 0 deletions.
  1. +40 −0 CONTRIBUTING.md
  2. +12 −0 CONTRIBUTING_FOR_COMMITTERS.md
View
@@ -0,0 +1,40 @@
+First of all, Welcome, and Thank You!
+
+Graphite has been a community project for years, and it only gets better by the efforts of people who volunteer. We sincerely appreciate that you care enough to see a problem, take the time to make this project better. Whether it's in the form of a bug report, code fix, or documentation improvement, we - the Graphite team - appreciate your help.
+
+This is a collection of practices that will make it easier for us to accept your contributions.
+
+
+### Issues
+
+While not mandatory, opening an Issue against the appropriate repo is seldom a bad thing. We prefer that you have searched through the existing issues. It's entirely possible that the issue has already been reported. It may have already been solved.
+
+If your issue in in-fact new, please write a descriptive report. Terse but complete is best. You should describe:
+
+* What you attempted
+* Expected Result
+* Witnessed Result
+* System Details
+ * OS / Version
+ * Python Version
+ * Django Version (a frequent cause of issues)
+ * Graphite Component Versions (or commit hash if running directly from the repo)
+
+
+### Tests
+
+We would absolutely love to improve our test coverage. If you see a gap, and can write a test for that, we'd eat that up.
+
+
+### Code
+
+If you see a mistake, have a feature, or a performance gain, we'd love to see it. It's _strongly_ encouraged for contributions that aren't already covered by tests to come with them. We're not trying to foist work on to you, but it makes it much easier for us to accept your contributions.
+
+
+### Documentation
+
+Graphite has historically not had great docs. It still doesn't. The good news is that docs are easy to contribute.
+
+Even if you don't know the intricacies of ReStructured Text (ReST), even bare unformatted paragraphs is better than nothing.
+
+English not your primary language? We'll work with you.
@@ -0,0 +1,12 @@
+First of all, Welcome, and Thank You!
+
+I don't know about you, but I'm in it for all of the glory that Obfuscurity promised...
+
+The team has grown some in the last year or so, so let's get some ground rules:
+
+* Be polite to the community.
+* We are part of the community.
+* Don't commit directly to the public repo. Please Fork and PR.
+* Unless things are publicly broken and nobody else is around to validate, don't merge your own PR.
+* If you're going to do something directly on the main repo, or something Meta (tags, releases, etc), other people should probably know about it. When in doubt, check with Obfuscurity or MLeinart.
+* Be polite to the community.

0 comments on commit 201bd15

Please sign in to comment.