Browse Source

Merge pull request #317 from square/federman/contributing

Add Contributing.md
Dan Federman 9 years ago
parent
commit
f19d973c8c
2 changed files with 20 additions and 10 deletions
  1. 19 0
      Contributing.md
  2. 1 10
      README.rst

+ 19 - 0
Contributing.md

@@ -0,0 +1,19 @@
+###Sign the CLA
+
+All contributors to your PR must sign our [Individual Contributor License Agreement (CLA)](https://spreadsheets.google.com/spreadsheet/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1). The CLA is a short form that ensures that you are eligible to contribute.
+
+###One issue or bug per Pull Request
+
+Keep your Pull Requests small. Small PRs are easier to reason about which makes them significantly more likely to get merged.
+
+###Issues before features
+
+If you want to add a feature, please file an [Issue](issues) first. An Issue gives us the opportunity to discuss the requirements and implications of a feature with you before you start writing code.
+
+###Backwards compatibility
+
+Respect the minimum deployment target. If you are adding code that uses new APIs, make sure to prevent older clients from crashing or misbehaving. Our CI runs against our minimum deployment targets, so you will not get a green build unless your code is backwards compatible. 
+
+###Forwards compatibility
+
+Please do not write new code using deprecated APIs.

+ 1 - 10
README.rst

@@ -243,13 +243,4 @@ you are already using twisted though, Autobahn is probably for you.
 
 Contributing
 ------------
-Any contributors to the master SocketRocket repository must sign the `Individual
-Contributor License Agreement
-(CLA)
-<https://spreadsheets.google.com/spreadsheet/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1>`_.
-It's a short form that covers our bases and makes sure you're eligible to
-contribute.
-
-When you have a change you'd like to see in the master repository, `send a pull
-request <https://github.com/square/SocketRocket/pulls>`_. Before we merge your
-request, we'll make sure you're in the list of people who have signed a CLA.
+We’re glad you’re interested in SocketRocket, and we’d love to see where you take it. Please read our `contributing guidelines <https://github.com/square/SocketRocket/blob/master/Contributing.md>`_ prior to submitting a Pull Request.