mirror of
https://github.com/eclipse/paho.mqtt.cpp.git
synced 2025-05-08 19:04:59 +08:00
Updated CONTRIBUTING doc and README
This commit is contained in:
fpagliughi
parent
a09b168872
commit
d67a92dbce
113
CONTRIBUTING.md
113
CONTRIBUTING.md
@ -1,47 +1,66 @@
|
||||
Contributing to Paho
|
||||
====================
|
||||
|
||||
Thanks for your interest in this project.
|
||||
|
||||
Project description:
|
||||
--------------------
|
||||
|
||||
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.
|
||||
|
||||
- https://projects.eclipse.org/projects/technology.paho
|
||||
|
||||
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
|
||||
|
||||
Contact:
|
||||
--------
|
||||
|
||||
Contact the project developers via the project's "dev" 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
|
||||
|
||||
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
|
||||
# Contributing to Paho
|
||||
|
||||
Thanks for your interest in this project!
|
||||
|
||||
You can contribute bugfixes and new features by sending pull requests through GitHub.
|
||||
|
||||
## Legal
|
||||
|
||||
In order for your contribution to be accepted, it must comply with the Eclipse Foundation IP policy.
|
||||
|
||||
Please read the [Eclipse Foundation policy on accepting contributions via Git](http://wiki.eclipse.org/Development_Resources/Contributing_via_Git).
|
||||
|
||||
1. Sign the [Eclipse ECA](http://www.eclipse.org/legal/ECA.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 [Eclipse projects forge](https://www.eclipse.org/contribute/cla), and click on 'Eclipse Contributor Agreement'.
|
||||
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: Alex Smith <alexsmith@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.
|
||||
|
||||
## Contributing a change
|
||||
|
||||
1. [Fork the repository on GitHub](https://github.com/eclipse/paho.mqtt.cpp/fork)
|
||||
2. Clone the forked repository onto your computer: ``` git clone https://github.com/<your username>/paho.mqtt.cpp.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 unit 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.cpp](https://github.com/eclipse/paho.mqtt.cpp) 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.
|
||||
|
||||
|
||||
What happens next depends on the content of the patch. If it is 100% authored
|
||||
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).
|
||||
|
||||
|
||||
|
||||
## Developer resources:
|
||||
|
||||
|
||||
Information regarding source code management, builds, coding standards, and more.
|
||||
|
||||
- [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 development
|
||||
[mailing list](https://dev.eclipse.org/mailman/listinfo/paho-dev).
|
||||
|
||||
Search for bugs:
|
||||
----------------
|
||||
|
||||
This project uses GitHub Issues here: [github.com/eclipse/paho.mqtt.cpp/issues](https://github.com/eclipse/paho.mqtt.cpp/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!
|
||||
|
||||
- [Create new Paho bug](https://github.com/eclipse/paho.mqtt.cpp/issues/new)
|
||||
|
||||
32
README.md
32
README.md
@ -8,15 +8,24 @@ This code builds a library which enables C++11 applications to connect to an [MQ
|
||||
|
||||
The library has the following features:
|
||||
|
||||
- Support for MQTT v5, v3.1.1, and v 3.1
|
||||
- TCP, SSL/TLS, and WebSocket transports
|
||||
- Support for MQTT v3.1, v3.1.1, and v5.
|
||||
- Network Transports:
|
||||
- Standard TCP
|
||||
- Secure sockets with SSL/TLS
|
||||
- WebSockets
|
||||
- Secure and insecure
|
||||
- Proxy support
|
||||
- Message persistence
|
||||
- Automatic reconnect
|
||||
- Offline buffering
|
||||
- High availability
|
||||
- User configurable
|
||||
- Built-in File persistence
|
||||
- User-defined key/value persistence easy to implement
|
||||
- Automatic Reconnect
|
||||
- Offline Buffering
|
||||
- High Availability
|
||||
- Blocking and non-blocking API's
|
||||
- Modern C++ interface (C++11 and better)
|
||||
|
||||
This code requires the [Paho C library](https://github.com/eclipse/paho.mqtt.c) by Ian Craggs, et al., specifically version 1.3.1 or possibly later.
|
||||
This code requires the [Paho C library](https://github.com/eclipse/paho.mqtt.c) by Ian Craggs, et al., specifically version 1.3.8 or possibly later.
|
||||
|
||||
## Latest News
|
||||
|
||||
@ -32,7 +41,7 @@ To keep up with the latest announcements for this project, or to ask questions:
|
||||
|
||||
### Unreleased Features in this Branch
|
||||
|
||||
**This branch requires Paho MQTT C library _v1.3.7_ or greater.**
|
||||
**This branch requires Paho MQTT C library _v1.3.8_ or greater.**
|
||||
|
||||
- New `create_options` that can be used to construct a client with new features:
|
||||
- Send while disconnected before the 1st successful connection
|
||||
@ -47,7 +56,7 @@ To keep up with the latest announcements for this project, or to ask questions:
|
||||
- [#227] Fixed race condition in thread-safe queue
|
||||
- [#224] & [#255] Subscribing to MQTT v3 broker with array of one topic causes segfault.
|
||||
|
||||
Targets Paho C v1.3.7
|
||||
Targets Paho C v1.3.8
|
||||
|
||||
### New Features in Paho C++ v1.1
|
||||
|
||||
@ -76,10 +85,11 @@ _Catch2_ can be found here: [Catch2](https://github.com/catchorg/Catch2)
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions to this project are gladly welcomed. Before submitting a Pull Request, please keep two things in mind:
|
||||
Contributions to this project are gladly welcomed and appreciated Before submitting a Pull Request, please keep three things in mind:
|
||||
|
||||
- This is an official Eclipse project, so it is required that all contributors sign an [Eclipse Contributor Agreement (ECA)](https://www.eclipse.org/legal/ECA.php)
|
||||
- Please submit all Pull Requests against the _develop_ branch (not master).
|
||||
- Please sign all commits.
|
||||
|
||||
For full details, see [CONTRIBUTING.md](https://github.com/eclipse/paho.mqtt.cpp/blob/master/CONTRIBUTING.md).
|
||||
|
||||
@ -89,7 +99,7 @@ Contributions to this project are gladly welcomed. Before submitting a Pull Requ
|
||||
|
||||
_CMake_ is a cross-platform build system suitable for Unix and non-Unix platforms such as Microsoft Windows. It is now the only supported build system.
|
||||
|
||||
The Paho C++ library requires the Paho C library, v1.3.7 or greater, to be built and installed first. More information below.
|
||||
The Paho C++ library requires the Paho C library, v1.3.8 or greater, to be built and installed first. More information below.
|
||||
|
||||
CMake allows for options to direct the build. The following are specific to Paho C++:
|
||||
|
||||
@ -146,7 +156,7 @@ Before building the C++ library, first, build and install the Paho C library:
|
||||
```
|
||||
$ git clone https://github.com/eclipse/paho.mqtt.c.git
|
||||
$ cd paho.mqtt.c
|
||||
$ git checkout v1.3.1
|
||||
$ git checkout v1.3.8
|
||||
|
||||
$ cmake -Bbuild -H. -DPAHO_WITH_SSL=ON -DPAHO_ENABLE_TESTING=OFF
|
||||
$ sudo cmake --build build/ --target install
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user