]> git.michaelhowe.org Git - packages/p/paho-mqtt.git/commitdiff
Add more details on contributing. v0.9
authorRoger Light <roger@atchoo.org>
Thu, 8 May 2014 08:23:26 +0000 (09:23 +0100)
committerRoger Light <roger@atchoo.org>
Thu, 8 May 2014 08:23:26 +0000 (09:23 +0100)
Change-Id: I2e4acfecf70f9ac483559aab10349a73406b44e1

CONTRIBUTING.md

index f6a8b7d0532521d3f76dcd46e05153c88158518e..493ab7d275e373f1312397cd657f4933e58994b9 100644 (file)
@@ -11,6 +11,52 @@ Paho reflects the inherent physical and cost constraints of device connectivity.
 \r
 - https://projects.eclipse.org/projects/technology.paho\r
 \r
+Source\r
+------\r
+\r
+The Paho Python code is stored in a git repository. The URLs to access it are:\r
+\r
+ssh://<username>@git.eclipse.org:29418/paho/org.eclipse.paho.mqtt.python\r
+https://<username>@git.eclipse.org/r/paho/org.eclipse.paho.mqtt.python\r
+\r
+A web browsable repository is available at\r
+\r
+http://git.eclipse.org/c/paho/org.eclipse.paho.mqtt.python.git\r
+\r
+Contributing a patch\r
+--------------------\r
+\r
+The Paho repositories are accessed through Gerrit, the code review\r
+project, which makes it possible for anybody to clone the repository, make\r
+changes and push them back for review and eventual acceptance into the project.\r
+\r
+To do this, you must follow a few steps. The first of these are described at\r
+\r
+- https://wiki.eclipse.org/Development_Resources/Contributing_via_Git\r
+\r
+* Sign the Eclipse CLA\r
+* Use a valid commit record, including a signed-off-by entry.\r
+\r
+There are further details at\r
+\r
+- https://wiki.eclipse.org/Development_Resources/Handling_Git_Contributions\r
+\r
+Once the patch is pushed back to Gerrit, the project committers will be\r
+informed and they will undertake a review of the code. The patch may need\r
+modifying for some reason. In order to make amending commits more\r
+straightforward, the steps at\r
+https://git.eclipse.org/r/Documentation/cmd-hook-commit-msg.html should be\r
+followed. This automatically inserts a "Change-Id" entry to your commit message\r
+which allows you to amend commits and have Gerrit track them as the same\r
+change.\r
+\r
+What happens next depends on the content of the patch. If it is 100% authored\r
+by the contributor and is less than 250 lines (and meets the needs of the\r
+project), then it can be committed to the main repository. If not, more steps\r
+are required. These are detailed in the legal process poster:\r
+\r
+- http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf\r
+\r
 Developer resources:\r
 --------------------\r
 \r