Permalink
Browse files

add CONTRIBUTING.md for display on Github

  • Loading branch information...
1 parent 2dfdd89 commit c09e1ff4e06496fd9ac23740f1a05e56f01e0bed @djmitche djmitche committed Sep 18, 2012
Showing with 18 additions and 0 deletions.
  1. +18 −0 CONTRIBUTING.md
View
@@ -0,0 +1,18 @@
+Contributing to Buildbot
+========================
+
+Thank you for contributing to Buildbot!
+
+What appears below is just a quick summary. See http://trac.buildbot.net/wiki/Development for the full story.
+
+Patches
+-------
+
+Contributions to Buildbot should come as a complete package. For code changes, tests and documentation updates should be included. Consider issues of compatibility, flexibility, and simplicity. Follow the existing Buildbot coding style, and be sure that your changes do not cause warnings from pyflakes. Patches are best submitted as Github pull requests, but also accepted as patch files attached to Trac tickets, or in attachments sent to the buildbot-devel mailing list. Patch guidelines are at http://trac.buildbot.net/wiki/SubmittingPatches.
+
+Your contribution must be licensed under the GPLv2, and copyright assignment is not expected (or possible: Buildbot is not a legal entity). See http://trac.buildbot.net/wiki/LicensingYourContribution for details.
+
+Development Tips
+----------------
+
+The easiest way to hack on Buildbot is in a virtualenv. See http://trac.buildbot.net/wiki/RunningBuildbotWithVirtualEnv for a description of how to set up such a thing.

0 comments on commit c09e1ff

Please sign in to comment.