Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Update outdated links and align with paho template document.
  • Loading branch information
MattBrittan authored Jan 6, 2024
2 parents 03ea98c + 509b6aa commit 4fe04ac
Showing 1 changed file with 38 additions and 18 deletions.
56 changes: 38 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,74 @@
Contributing to Paho
====================
Contributing to Eclipse Paho
============================

Thanks for your interest in this project.

Project description:
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.
The Eclipse Paho project provides 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. Paho contains 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
- https://projects.eclipse.org/projects/iot.paho

Developer resources:
Terms of Use:
-------------

This repository is subject to the Terms of Use of the Eclipse Foundation

- https://www.eclipse.org/legal/termsofuse.php

Developer Resources:
--------------------

Information regarding source code management, builds, coding standards, and more.
Github repositories maintained by the project

- https://projects.eclipse.org/projects/iot.paho/developer

Eclipse Development Process:
----------------------------

- https://projects.eclipse.org/projects/technology.paho/developer
This Eclipse Foundation open project is governed by the Eclipse Foundation Development Process and operates under the terms of the Eclipse IP Policy.

Contributor License Agreement:
- https://www.eclipse.org/projects/dev_process
- https://www.eclipse.org/org/documents/Eclipse_IP_Policy.pdf

Eclipse Contributor Agreement:
------------------------------

Before your contribution can be accepted by the project, you need to create and electronically sign the Eclipse Foundation Contributor License Agreement (CLA).
In order to be able to contribute to Eclipse Foundation projects you must electronically sign the Eclipse Contributor Agreement (ECA).

- https://www.eclipse.org/legal/ECA.php

- http://www.eclipse.org/legal/CLA.php
The ECA provides the Eclipse Foundation with a permanent record that you agree that each of your contributions will comply with the commitments documented in the Developer Certificate of Origin (DCO). Having an ECA on file associated with the email address matching the "Author" field of your contribution's Git commits fulfills the DCO's requirement that you sign-off on your contributions.

For more information, please see the Eclipse Committer Handbook:\
https://www.eclipse.org/projects/handbook/#resources-commit

Contributing Code:
------------------

The Go client is developed in Github, see their documentation on the process of forking and pull requests; https://help.github.com/categories/collaborating-on-projects-using-pull-requests/

Git commit messages should follow the style described here;
The Go client is developed in Github, see their documentation on the process of forking and pull requests\
https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models

Git commit messages should follow the style described here\
http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

Contact:
--------

Contact the project developers via the project's "dev" list.

- https://dev.eclipse.org/mailman/listinfo/paho-dev
- https://accounts.eclipse.org/mailing-list/paho-dev

Search for bugs:
Search for Bugs:
----------------

This project uses Github issues to track ongoing development and issues.

- https://github.com/eclipse/paho.golang/issues

Create a new bug:
Create a New Bug:
-----------------

Be sure to search for existing bugs before you create another one. Remember that contributions are always welcome!
Expand Down

0 comments on commit 4fe04ac

Please sign in to comment.