Skip to content

Commit 0c0328b

Browse files
author
Ian Craggs
committed
Update CONTRIBUTING file
1 parent 1242b6b commit 0c0328b

1 file changed

Lines changed: 87 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 87 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,90 @@
1-
Contributing to Paho
1+
Contributing to Paho
2+
====================
3+
4+
Thanks for your interest in this project.
5+
6+
Project description:
7+
--------------------
8+
9+
The Paho project has been created to provide reliable open-source implementations of open and standard messaging protocols aimed at new, existing, and emerging applications for Machine-to-Machine (M2M) and Internet of Things (IoT).
10+
Paho reflects the inherent physical and cost constraints of device connectivity. Its objectives include effective levels of decoupling between devices and applications, designed to keep markets open and encourage the rapid growth of scalable Web and Enterprise middleware and applications.
11+
12+
- [Project web site](https://www.eclipse.org/paho)
13+
- [Project information](https://projects.eclipse.org/projects/iot.paho)
14+
15+
Source
16+
------
17+
18+
The Paho Java client and Android service are stored in a git repository. The URLs to access it are:
19+
20+
ssh://<username>@git.eclipse.org:29418/paho/org.eclipse.paho.mqtt.java
21+
https://<username>@git.eclipse.org/r/paho/org.eclipse.paho.mqtt.java
22+
23+
A [web browsable repository](http://git.eclipse.org/c/paho/org.eclipse.paho.mqtt.java.git) is available.
24+
25+
Contributing a patch
26+
--------------------
27+
28+
The Paho repositories are accessed through Gerrit, the code review
29+
project, which makes it possible for anybody to clone the repository, make
30+
changes and push them back for review and eventual acceptance into the project.
31+
32+
To do this, you must follow a few steps. The first of these are described at
33+
34+
- [Contributing via git](https://wiki.eclipse.org/Development_Resources/Contributing_via_Git)
35+
36+
* Sign the Eclipse CLA
37+
* Use a valid commit record, including a signed-off-by entry.
38+
39+
There are further details at
40+
41+
- [Handling Git Contributions](https://wiki.eclipse.org/Development_Resources/Handling_Git_Contributions)
42+
43+
Once the patch is pushed back to Gerrit, the project committers will be
44+
informed and they will undertake a review of the code. The patch may need
45+
modifying for some reason. In order to make amending commits more
46+
straightforward, the steps at
47+
https://git.eclipse.org/r/Documentation/cmd-hook-commit-msg.html should be
48+
followed. This automatically inserts a "Change-Id" entry to your commit message
49+
which allows you to amend commits and have Gerrit track them as the same
50+
change.
51+
52+
What happens next depends on the content of the patch. If it is 100% authored
53+
by the contributor and is less than 1000 lines (and meets the needs of the
54+
project), then it can be committed to the main repository. If not, more steps
55+
are required. These are detailed in the
56+
[legal process poster](http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf).
57+
58+
59+
Developer resources:
60+
--------------------
61+
62+
Information regarding source code management, builds, coding standards, and more.
63+
64+
- [https://projects.eclipse.org/projects/iot.paho/developer](https://projects.eclipse.org/projects/iot.paho/developer)
65+
66+
Contributor License Agreement:
67+
------------------------------
68+
69+
Before your contribution can be accepted by the project, you need to create and electronically sign the Eclipse Foundation [Contributor License Agreement (CLA)](http://www.eclipse.org/legal/CLA.php).
70+
71+
Contact:
72+
--------
73+
74+
Contact the project developers via the project's development
75+
[mailing list](https://dev.eclipse.org/mailman/listinfo/paho-dev).
76+
77+
Search for bugs:
78+
----------------
79+
80+
This project uses [Bugzilla](https://bugs.eclipse.org/bugs/buglist.cgi?product=Paho) to track ongoing development and issues.
81+
82+
Create a new bug:
83+
-----------------
84+
85+
Be sure to search for existing bugs before you create another one. Remember that contributions are always welcome!
86+
87+
- [Create new Paho bug](https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Paho)Contributing to Paho
288
====================
389

490
Thanks for your interest in this project.

0 commit comments

Comments
 (0)