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.

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

Update CONTRIBUTING.md #218

Merged
merged 2 commits into from
Jan 6, 2024
Merged

Update CONTRIBUTING.md #218

merged 2 commits into from
Jan 6, 2024

Conversation

minyukim
Copy link
Contributor

@minyukim minyukim commented Jan 3, 2024

closes #217
Update CONTRIBUTING.md to reflect current status

Update to reflect current status
Copy link
Contributor

@MattBrittan MattBrittan left a comment

Choose a reason for hiding this comment

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

I found a generic paho contributors agreement (https://www.eclipse.org/projects/tools/documentation.php?id=iot.paho - not sure what access is needed to see this) that I was not previously aware of and added it as a comment (probably worth adding a couple of sections from this). Have only made one other suggestion.
I'm happy to go with this as-is or, if you have time, it would be great to make the couple of changes suggested.

CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@@ -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.

Copy some contents from full suggested contributor agreement of the paho project
@MattBrittan MattBrittan merged commit 4fe04ac into eclipse:master Jan 6, 2024
1 check passed
@minyukim minyukim deleted the patch-1 branch January 6, 2024 01:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update CONTRIBUTING.md
2 participants