Pavle Radojkovic / mbed-mqtt

Library for MQTT

mbed-mqtt-master/paho_mqtt_embedded_c/CONTRIBUTING.md@0:ba7e439238ab, 2022-06-20 (annotated)

Committer:
pavleradojkovic
Date:
Mon Jun 20 16:24:43 2022 +0000
Revision:
0:ba7e439238ab
Inital commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
pavleradojkovic 0:ba7e439238ab 1 # Contributing to Paho
pavleradojkovic 0:ba7e439238ab 2
pavleradojkovic 0:ba7e439238ab 3 Thanks for your interest in this project!
pavleradojkovic 0:ba7e439238ab 4
pavleradojkovic 0:ba7e439238ab 5 You can contribute bugfixes and new features by sending pull requests through GitHub.
pavleradojkovic 0:ba7e439238ab 6
pavleradojkovic 0:ba7e439238ab 7 ## Legal
pavleradojkovic 0:ba7e439238ab 8
pavleradojkovic 0:ba7e439238ab 9 In order for your contribution to be accepted, it must comply with the Eclipse Foundation IP policy.
pavleradojkovic 0:ba7e439238ab 10
pavleradojkovic 0:ba7e439238ab 11 Please read the [Eclipse Foundation policy on accepting contributions via Git](http://wiki.eclipse.org/Development_Resources/Contributing_via_Git).
pavleradojkovic 0:ba7e439238ab 12
pavleradojkovic 0:ba7e439238ab 13 1. Sign the [Eclipse ECA](http://www.eclipse.org/legal/ECA.php)
pavleradojkovic 0:ba7e439238ab 14 1. Register for an Eclipse Foundation User ID. You can register [here](https://dev.eclipse.org/site_login/createaccount.php).
pavleradojkovic 0:ba7e439238ab 15 2. Log into the [Eclipse projects forge](https://www.eclipse.org/contribute/cla), and click on 'Eclipse Contributor Agreement'.
pavleradojkovic 0:ba7e439238ab 16 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.
pavleradojkovic 0:ba7e439238ab 17 3. Make sure that you _sign-off_ your Git commits in the following format:
pavleradojkovic 0:ba7e439238ab 18 ``` 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"```
pavleradojkovic 0:ba7e439238ab 19 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.
pavleradojkovic 0:ba7e439238ab 20
pavleradojkovic 0:ba7e439238ab 21 ## Contributing a change
pavleradojkovic 0:ba7e439238ab 22
pavleradojkovic 0:ba7e439238ab 23 1. [Fork the repository on GitHub](https://github.com/eclipse/paho.mqtt.embedded-c/fork)
pavleradojkovic 0:ba7e439238ab 24 2. Clone the forked repository onto your computer: ``` git clone https://github.com/<your username>/paho.mqtt.embedded-c.git ```
pavleradojkovic 0:ba7e439238ab 25 3. Create a new branch from the latest ```develop``` branch with ```git checkout -b YOUR_BRANCH_NAME origin/develop```
pavleradojkovic 0:ba7e439238ab 26 4. Make your changes
pavleradojkovic 0:ba7e439238ab 27 5. If developing a new feature, make sure to include JUnit tests.
pavleradojkovic 0:ba7e439238ab 28 6. Ensure that all new and existing tests pass.
pavleradojkovic 0:ba7e439238ab 29 7. Commit the changes into the branch: ``` git commit -s ``` Make sure that your commit message is meaningful and describes your changes correctly.
pavleradojkovic 0:ba7e439238ab 30 8. If you have a lot of commits for the change, squash them into a single / few commits.
pavleradojkovic 0:ba7e439238ab 31 9. Push the changes in your branch to your forked repository.
pavleradojkovic 0:ba7e439238ab 32 10. Finally, go to [https://github.com/eclipse/paho.mqtt.embedded-c](https://github.com/eclipse/paho.mqtt.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.
pavleradojkovic 0:ba7e439238ab 33
pavleradojkovic 0:ba7e439238ab 34
pavleradojkovic 0:ba7e439238ab 35 What happens next depends on the content of the patch. If it is 100% authored
pavleradojkovic 0:ba7e439238ab 36 by the contributor and is less than 1000 lines (and meets the needs of the
pavleradojkovic 0:ba7e439238ab 37 project), then it can be pulled into the main repository. If not, more steps
pavleradojkovic 0:ba7e439238ab 38 are required. These are detailed in the
pavleradojkovic 0:ba7e439238ab 39 [legal process poster](http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf).
pavleradojkovic 0:ba7e439238ab 40
pavleradojkovic 0:ba7e439238ab 41
pavleradojkovic 0:ba7e439238ab 42
pavleradojkovic 0:ba7e439238ab 43 ## Developer resources:
pavleradojkovic 0:ba7e439238ab 44
pavleradojkovic 0:ba7e439238ab 45
pavleradojkovic 0:ba7e439238ab 46 Information regarding source code management, builds, coding standards, and more.
pavleradojkovic 0:ba7e439238ab 47
pavleradojkovic 0:ba7e439238ab 48 - [https://projects.eclipse.org/projects/iot.paho/developer](https://projects.eclipse.org/projects/iot.paho/developer)
pavleradojkovic 0:ba7e439238ab 49
pavleradojkovic 0:ba7e439238ab 50 Contact:
pavleradojkovic 0:ba7e439238ab 51 --------
pavleradojkovic 0:ba7e439238ab 52
pavleradojkovic 0:ba7e439238ab 53 Contact the project developers via the project's development
pavleradojkovic 0:ba7e439238ab 54 [mailing list](https://dev.eclipse.org/mailman/listinfo/paho-dev).
pavleradojkovic 0:ba7e439238ab 55
pavleradojkovic 0:ba7e439238ab 56 Search for bugs:
pavleradojkovic 0:ba7e439238ab 57 ----------------
pavleradojkovic 0:ba7e439238ab 58
pavleradojkovic 0:ba7e439238ab 59 This project uses GitHub Issues here: [github.com/eclipse/paho.mqtt.embedded-c/issues](https://github.com/eclipse/paho.mqtt.embedded-c/issues) to track ongoing development and issues.
pavleradojkovic 0:ba7e439238ab 60
pavleradojkovic 0:ba7e439238ab 61 Create a new bug:
pavleradojkovic 0:ba7e439238ab 62 -----------------
pavleradojkovic 0:ba7e439238ab 63
pavleradojkovic 0:ba7e439238ab 64 Be sure to search for existing bugs before you create another one. Remember that contributions are always welcome!
pavleradojkovic 0:ba7e439238ab 65
pavleradojkovic 0:ba7e439238ab 66 - [Create new Paho bug](https://github.com/eclipse/paho.mqtt.embedded-c/issues)