mirror of
https://github.com/eclipse/paho.mqtt-sn.embedded-c.git
synced 2025-12-13 07:26:52 +01:00
Merge pull request #5 from jpwsutton/master
Updating CONTRIBUTING.md & README.md on master branch
This commit is contained in:
James Sutton
@@ -1,93 +1,68 @@
|
||||
Contributing to Paho
|
||||
====================
|
||||
# Contributing to Paho
|
||||
|
||||
Thanks for your interest in this project.
|
||||
Thanks for your interest in this project!
|
||||
|
||||
Project description:
|
||||
--------------------
|
||||
You can contribute bugfixes and new features by sending pull requests through GitHub.
|
||||
|
||||
The Paho project has been created to provide scalable 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).
|
||||
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. Paho is being kicked off with MQTT publish/subscribe client implementations for use on embedded platforms, along with corresponding server support as determined by the community.
|
||||
## Legal
|
||||
|
||||
- https://projects.eclipse.org/projects/technology.paho
|
||||
In order for your contribution to be accepted, it must comply with the Eclipse Foundation IP policy.
|
||||
|
||||
Source
|
||||
------
|
||||
Please read the [Eclipse Foundation policy on accepting contributions via Git](http://wiki.eclipse.org/Development_Resources/Contributing_via_Git).
|
||||
|
||||
The Paho Embedded C/C++ MQTT-SN client code is stored in a git repository. The URLs to access it are:
|
||||
1. Sign the [Eclipse CLA](http://www.eclipse.org/legal/CLA.php)
|
||||
1. Register for an Eclipse Foundation User ID. You can register [here](https://dev.eclipse.org/site_login/createaccount.php).
|
||||
2. Log into the [Projects Portal](https://projects.eclipse.org/), and click on the '[Eclipse CLA](https://projects.eclipse.org/user/sign/cla)' link.
|
||||
2. Go to your [account settings](https://dev.eclipse.org/site_login/myaccount.php#open_tab_accountsettings) and add your GitHub username to your account.
|
||||
3. Make sure that you _sign-off_ your Git commits in the following format:
|
||||
``` Signed-off-by: John Smith <johnsmith@nowhere.com> ``` This is usually at the bottom of the commit message. You can automate this by adding the '-s' flag when you make the commits. e.g. ```git commit -s -m "Adding a cool feature"```
|
||||
4. Ensure that the email address that you make your commits with is the same one you used to sign up to the Eclipse Foundation website with.
|
||||
|
||||
ssh://<username>@git.eclipse.org:29418/paho/org.eclipse.paho.mqtt-sn.embedded-c
|
||||
https://<username>@git.eclipse.org/r/paho/org.eclipse.paho.mqtt-sn.embedded-c
|
||||
## Contributing a change
|
||||
|
||||
A web browsable repository is available at
|
||||
## Contributing a change
|
||||
|
||||
http://git.eclipse.org/c/paho/org.eclipse.paho.mqtt-sn.embedded-c.git
|
||||
1. [Fork the repository on GitHub](https://github.com/eclipse/paho.mqtt-sn.embedded-c/fork)
|
||||
2. Clone the forked repository onto your computer: ``` git clone https://github.com/<your username>/paho.mqtt-sn.embedded-c.git ```
|
||||
3. Create a new branch from the latest ```develop``` branch with ```git checkout -b YOUR_BRANCH_NAME origin/develop```
|
||||
4. Make your changes
|
||||
5. If developing a new feature, make sure to include JUnit tests.
|
||||
6. Ensure that all new and existing tests pass.
|
||||
7. Commit the changes into the branch: ``` git commit -s ``` Make sure that your commit message is meaningful and describes your changes correctly.
|
||||
8. If you have a lot of commits for the change, squash them into a single / few commits.
|
||||
9. Push the changes in your branch to your forked repository.
|
||||
10. Finally, go to [https://github.com/eclipse/paho.mqtt-sn.embedded-c](https://github.com/eclipse/paho.mqtt-sn.embedded-c) and create a pull request from your "YOUR_BRANCH_NAME" branch to the ```develop``` one to request review and merge of the commits in your pushed branch.
|
||||
|
||||
Contributing a patch
|
||||
--------------------
|
||||
|
||||
The Paho repositories are accessed through Gerrit, the code review
|
||||
project, which makes it possible for anybody to clone the repository, make
|
||||
changes and push them back for review and eventual acceptance into the project.
|
||||
|
||||
To do this, you must follow a few steps. The first of these are described at
|
||||
|
||||
- https://wiki.eclipse.org/Development_Resources/Contributing_via_Git
|
||||
|
||||
* Sign the Eclipse CLA
|
||||
* Use a valid commit record, including a signed-off-by entry.
|
||||
|
||||
There are further details at
|
||||
|
||||
- https://wiki.eclipse.org/Development_Resources/Handling_Git_Contributions
|
||||
|
||||
Once the patch is pushed back to Gerrit, the project committers will be
|
||||
informed and they will undertake a review of the code. The patch may need
|
||||
modifying for some reason. In order to make amending commits more
|
||||
straightforward, the steps at
|
||||
https://git.eclipse.org/r/Documentation/cmd-hook-commit-msg.html should be
|
||||
followed. This automatically inserts a "Change-Id" entry to your commit message
|
||||
which allows you to amend commits and have Gerrit track them as the same
|
||||
change.
|
||||
|
||||
What happens next depends on the content of the patch. If it is 100% authored
|
||||
by the contributor and is less than 250 lines (and meets the needs of the
|
||||
project), then it can be committed to the main repository. If not, more steps
|
||||
are required. These are detailed in the legal process poster:
|
||||
by the contributor and is less than 1000 lines (and meets the needs of the
|
||||
project), then it can be pulled into the main repository. If not, more steps
|
||||
are required. These are detailed in the
|
||||
[legal process poster](http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf).
|
||||
|
||||
- http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf
|
||||
|
||||
Developer resources:
|
||||
--------------------
|
||||
|
||||
## Developer resources:
|
||||
|
||||
|
||||
Information regarding source code management, builds, coding standards, and more.
|
||||
|
||||
- https://projects.eclipse.org/projects/technology.paho/developer
|
||||
|
||||
Contributor License Agreement:
|
||||
------------------------------
|
||||
|
||||
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
|
||||
- [https://projects.eclipse.org/projects/iot.paho/developer](https://projects.eclipse.org/projects/iot.paho/developer)
|
||||
|
||||
Contact:
|
||||
--------
|
||||
|
||||
Contact the project developers via the project's "dev" list.
|
||||
|
||||
- https://dev.eclipse.org/mailman/listinfo/paho-dev
|
||||
Contact the project developers via the project's development
|
||||
[mailing list](https://dev.eclipse.org/mailman/listinfo/paho-dev).
|
||||
|
||||
Search for bugs:
|
||||
----------------
|
||||
|
||||
This project uses Bugzilla to track ongoing development and issues.
|
||||
|
||||
- https://bugs.eclipse.org/bugs/buglist.cgi?product=Paho
|
||||
This project uses GitHub Issues here: [github.com/eclipse/paho.mqtt-sn.embedded-c/issues](https://github.com/eclipse/paho.mqtt-sn.embedded-c/issues) to track ongoing development and issues.
|
||||
|
||||
Create a new bug:
|
||||
-----------------
|
||||
|
||||
Be sure to search for existing bugs before you create another one. Remember that contributions are always welcome!
|
||||
|
||||
- https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Paho
|
||||
- [Create new Paho bug](https://github.com/eclipse/paho.mqtt-sn.embedded-c/issues/new)
|
||||
|
||||
19
README.md
Normal file
19
README.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# Eclipse Paho MQTT-SN Embedded C client
|
||||
|
||||
|
||||
|
||||
## Project description:
|
||||
|
||||
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).
|
||||
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.
|
||||
|
||||
|
||||
## Links
|
||||
|
||||
- Project Website: [https://www.eclipse.org/paho](https://www.eclipse.org/paho)
|
||||
- Eclipse Project Information: [https://projects.eclipse.org/projects/iot.paho](https://projects.eclipse.org/projects/iot.paho)
|
||||
- Paho Testing Page: [https://www.eclipse.org/paho/clients/testing/](https://www.eclipse.org/paho/clients/testing/)
|
||||
- GitHub: [https://github.com/eclipse/paho.mqtt.testing](https://github.com/eclipse/paho.mqtt.testing)
|
||||
- Twitter: [@eclipsepaho](https://twitter.com/eclipsepaho)
|
||||
- Issues: [https://github.com/eclipse/paho.mqtt.testing/issues](https://github.com/eclipse/paho.mqtt.testing/issues)
|
||||
- Mailing-list: [https://dev.eclipse.org/mailman/listinfo/paho-dev](https://dev.eclipse.org/mailman/listinfo/paho-dev)
|
||||
Reference in New Issue
Block a user