Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update CONTRIBUTING.md #218

Merged
merged 2 commits into from
Jan 6, 2024
Merged

Update CONTRIBUTING.md #218

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5249e2b
Update CONTRIBUTING.md
minyukim Jan 3, 2024
509b6aa
Update CONTRIBUTING.md
minyukim Jan 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 13 additions & 20 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,52 +3,45 @@ Contributing to Paho

Thanks for your interest in this project.

Project description:
Project Description:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is the full suggested contributor agreement from the paho project (I think most of these points are covered and having this customised to the project is good). It would be good to copy the full section re the contributor agreement (as I think it's important to explain why this is required) and I guess the terms of use section should be there (legal team probably would like that!).

Contributing to Eclipse Paho

Thanks for your interest in this project.

Project description

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.

Terms of Use

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

Developer resources

Information regarding source code management, builds, coding standards, and
more.

The project maintains the following source code repositories

Eclipse Development Process

This Eclipse Foundation open project is governed by the Eclipse Foundation
Development Process and operates under the terms of the Eclipse IP Policy.

Eclipse Contributor Agreement

In order to be able to contribute to Eclipse Foundation projects you must
electronically sign the Eclipse Contributor Agreement (ECA).

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

Contact

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MattBrittan Thank you for the resource and suggestions!
I made some change based on them.

--------------------

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).\
minyukim marked this conversation as resolved.
Show resolved Hide resolved
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:
--------------------

Information regarding source code management, builds, coding standards, and more.

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

Contributor License Agreement:
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).
Before your contribution can be accepted by the project, you need to create and electronically sign the Eclipse Contributor Agreement (ECA).

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

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://help.github.com/categories/collaborating-on-projects-using-pull-requests/
minyukim marked this conversation as resolved.
Show resolved Hide resolved

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