Skip to content

Commit e6ad811

Browse files
committed
Add required Eclipse meta data files
1 parent b2e64bc commit e6ad811

File tree

4 files changed

+197
-53
lines changed

4 files changed

+197
-53
lines changed

CODE_OF_CONDUCT.md

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
# Community Code of Conduct
2+
3+
**Version 2.0
4+
January 1, 2023**
5+
6+
## Our Pledge
7+
8+
In the interest of fostering an open and welcoming environment, we as community members, contributors, Committers[^1], and Project Leads (collectively "Contributors") pledge to make participation in our projects and our community a harassment-free and inclusive experience for everyone.
9+
10+
This Community Code of Conduct ("Code") outlines our behavior expectations as members of our community in all Eclipse Foundation activities, both offline and online. It is not intended to govern scenarios or behaviors outside of the scope of Eclipse Foundation activities. Nor is it intended to replace or supersede the protections offered to all our community members under the law. Please follow both the spirit and letter of this Code and encourage other Contributors to follow these principles into our work. Failure to read or acknowledge this Code does not excuse a Contributor from compliance with the Code.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contribute to creating a positive and professional environment include:
15+
16+
- Using welcoming and inclusive language;
17+
- Actively encouraging all voices;
18+
- Helping others bring their perspectives and listening actively. If you find yourself dominating a discussion, it is especially important to encourage other voices to join in;
19+
- Being respectful of differing viewpoints and experiences;
20+
- Gracefully accepting constructive criticism;
21+
- Focusing on what is best for the community;
22+
- Showing empathy towards other community members;
23+
- Being direct but professional; and
24+
- Leading by example by holding yourself and others accountable
25+
26+
Examples of unacceptable behavior by Contributors include:
27+
28+
- The use of sexualized language or imagery;
29+
- Unwelcome sexual attention or advances;
30+
- Trolling, insulting/derogatory comments, and personal or political attacks;
31+
- Public or private harassment, repeated harassment;
32+
- Publishing others' private information, such as a physical or electronic address, without explicit permission;
33+
- Violent threats or language directed against another person;
34+
- Sexist, racist, or otherwise discriminatory jokes and language;
35+
- Posting sexually explicit or violent material;
36+
- Sharing private content, such as emails sent privately or non-publicly, or unlogged forums such as IRC channel history;
37+
- Personal insults, especially those using racist or sexist terms;
38+
- Excessive or unnecessary profanity;
39+
- Advocating for, or encouraging, any of the above behavior; and
40+
- Other conduct which could reasonably be considered inappropriate in a professional setting
41+
42+
## Our Responsibilities
43+
44+
With the support of the Eclipse Foundation employees, consultants, officers, and directors (collectively, the "Staff"), Committers, and Project Leads, the Eclipse Foundation Conduct Committee (the "Conduct Committee") is responsible for clarifying the standards of acceptable behavior. The Conduct Committee takes appropriate and fair corrective action in response to any instances of unacceptable behavior.
45+
46+
## Scope
47+
48+
This Code applies within all Project, Working Group, and Interest Group spaces and communication channels of the Eclipse Foundation (collectively, "Eclipse spaces"), within any Eclipse-organized event or meeting, and in public spaces when an individual is representing an Eclipse Foundation Project, Working Group, Interest Group, or their communities. Examples of representing a Project or community include posting via an official social media account, personal accounts, or acting as an appointed representative at an online or offline event. Representation of Projects, Working Groups, and Interest Groups may be further defined and clarified by Committers, Project Leads, or the Staff.
49+
50+
## Enforcement
51+
52+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the Conduct Committee via [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Without the explicit consent of the reporter, the Conduct Committee is obligated to maintain confidentiality with regard to the reporter of an incident. The Conduct Committee is further obligated to ensure that the respondent is provided with sufficient information about the complaint to reply. If such details cannot be provided while maintaining confidentiality, the Conduct Committee will take the respondent‘s inability to provide a defense into account in its deliberations and decisions. Further details of enforcement guidelines may be posted separately.
53+
54+
Staff, Committers and Project Leads have the right to report, remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code, or to block temporarily or permanently any Contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. Any such actions will be reported to the Conduct Committee for transparency and record keeping.
55+
56+
Any Staff (including officers and directors of the Eclipse Foundation), Committers, Project Leads, or Conduct Committee members who are the subject of a complaint to the Conduct Committee will be recused from the process of resolving any such complaint.
57+
58+
## Responsibility
59+
60+
The responsibility for administering this Code rests with the Conduct Committee, with oversight by the Executive Director and the Board of Directors. For additional information on the Conduct Committee and its process, please write to <[email protected]>.
61+
62+
## Investigation of Potential Code Violations
63+
64+
All conflict is not bad as a healthy debate may sometimes be necessary to push us to do our best. It is, however, unacceptable to be disrespectful or offensive, or violate this Code. If you see someone engaging in objectionable behavior violating this Code, we encourage you to address the behavior directly with those involved. If for some reason, you are unable to resolve the matter or feel uncomfortable doing so, or if the behavior is threatening or harassing, please report it following the procedure laid out below.
65+
66+
Reports should be directed to <[email protected]>. It is the Conduct Committee’s role to receive and address reported violations of this Code and to ensure a fair and speedy resolution.
67+
68+
The Eclipse Foundation takes all reports of potential Code violations seriously and is committed to confidentiality and a full investigation of all allegations. The identity of the reporter will be omitted from the details of the report supplied to the accused. Contributors who are being investigated for a potential Code violation will have an opportunity to be heard prior to any final determination. Those found to have violated the Code can seek reconsideration of the violation and disciplinary action decisions. Every effort will be made to have all matters disposed of within 60 days of the receipt of the complaint.
69+
70+
## Actions
71+
Contributors who do not follow this Code in good faith may face temporary or permanent repercussions as determined by the Conduct Committee.
72+
73+
This Code does not address all conduct. It works in conjunction with our [Communication Channel Guidelines](https://www.eclipse.org/org/documents/communication-channel-guidelines/), [Social Media Guidelines](https://www.eclipse.org/org/documents/social_media_guidelines.php), [Bylaws](https://www.eclipse.org/org/documents/eclipse-foundation-be-bylaws-en.pdf), and [Internal Rules](https://www.eclipse.org/org/documents/ef-be-internal-rules.pdf) which set out additional protections for, and obligations of, all contributors. The Foundation has additional policies that provide further guidance on other matters.
74+
75+
It’s impossible to spell out every possible scenario that might be deemed a violation of this Code. Instead, we rely on one another’s good judgment to uphold a high standard of integrity within all Eclipse Spaces. Sometimes, identifying the right thing to do isn’t an easy call. In such a scenario, raise the issue as early as possible.
76+
77+
## No Retaliation
78+
79+
The Eclipse community relies upon and values the help of Contributors who identify potential problems that may need to be addressed within an Eclipse Space. Any retaliation against a Contributor who raises an issue honestly is a violation of this Code. That a Contributor has raised a concern honestly or participated in an investigation, cannot be the basis for any adverse action, including threats, harassment, or discrimination. If you work with someone who has raised a concern or provided information in an investigation, you should continue to treat the person with courtesy and respect. If you believe someone has retaliated against you, report the matter as described by this Code. Honest reporting does not mean that you have to be right when you raise a concern; you just have to believe that the information you are providing is accurate.
80+
81+
False reporting, especially when intended to retaliate or exclude, is itself a violation of this Code and will not be accepted or tolerated.
82+
83+
Everyone is encouraged to ask questions about this Code. Your feedback is welcome, and you will get a response within three business days. Write to <[email protected]>.
84+
85+
## Amendments
86+
87+
The Eclipse Foundation Board of Directors may amend this Code from time to time and may vary the procedures it sets out where appropriate in a particular case.
88+
89+
### Attribution
90+
91+
This Code was inspired by the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.4, available [here](https://www.contributor-covenant.org/version/1/4/code-of-conduct/).
92+
93+
[^1]: Capitalized terms used herein without definition shall have the meanings assigned to them in the Bylaws.
94+

CONTRIBUTING.md

+32-53
Original file line numberDiff line numberDiff line change
@@ -1,87 +1,66 @@
1-
Contributing to Paho
2-
====================
1+
# Contributing to Paho
32

4-
Thanks for your interest in this project.
3+
Thanks for your interest in this project!
54

6-
Project description:
7-
--------------------
5+
You can contribute bugfixes and new features by sending pull requests through GitHub.
86

9-
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).
10-
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.
7+
## Legal
118

12-
- [Project web site](https://www.eclipse.org/paho)
13-
- [Project information](https://projects.eclipse.org/projects/iot.paho)
9+
In order for your contribution to be accepted, it must comply with the Eclipse Foundation IP policy.
1410

15-
Source
16-
------
11+
Please read the [Eclipse Foundation policy on accepting contributions via Git](http://wiki.eclipse.org/Development_Resources/Contributing_via_Git).
1712

18-
The Paho .Net & WinRT client is stored in a git repository. The URLs to access it are:
13+
1. Sign the [Eclipse ECA](http://www.eclipse.org/legal/ECA.php)
14+
1. Register for an Eclipse Foundation User ID. You can register [here](https://dev.eclipse.org/site_login/createaccount.php).
15+
2. Log into the [Eclipse projects forge](https://www.eclipse.org/contribute/cla), and click on 'Eclipse Contributor Agreement'.
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.
17+
3. Make sure that you _sign-off_ your Git commits in the following format:
18+
``` Signed-off-by: Alex Smith <[email protected]> ``` 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"```
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.
1920

20-
- ssh://<username>@git.eclipse.org:29418/paho/org.eclipse.paho.mqtt.m2mqtt
21-
- https://<username>@git.eclipse.org/r/paho/org.eclipse.paho.mqtt.m2mqtt
21+
## Contributing a change
2222

23-
A [web browsable repository](http://git.eclipse.org/c/paho/org.eclipse.paho.mqtt.m2mqtt.git) is available.
23+
1. [Fork the repository on GitHub](https://github.com/eclipse/paho.mqtt.c/fork)
24+
2. Clone the forked repository onto your computer: ``` git clone https://github.com/<your username>/paho.mqtt.c.git ```
25+
3. Create a new branch from the latest ```develop``` branch with ```git checkout -b YOUR_BRANCH_NAME origin/develop```
26+
4. Make your changes
27+
5. If developing a new feature, make sure to include JUnit tests.
28+
6. Ensure that all new and existing tests pass.
29+
7. Commit the changes into the branch: ``` git commit -s ``` Make sure that your commit message is meaningful and describes your changes correctly.
30+
8. If you have a lot of commits for the change, squash them into a single / few commits.
31+
9. Push the changes in your branch to your forked repository.
32+
10. Finally, go to [https://github.com/eclipse/paho.mqtt.c](https://github.com/eclipse/paho.mqtt.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.
2433

25-
Contributing a patch
26-
--------------------
27-
28-
The Paho repositories are accessed through Gerrit, the code review
29-
project, which makes it possible for anybody to clone the repository, make
30-
changes and push them back for review and eventual acceptance into the project.
31-
32-
To do this, you must follow a few steps. The first of these are described at
33-
34-
- [Contributing via git](https://wiki.eclipse.org/Development_Resources/Contributing_via_Git)
35-
36-
* Sign the Eclipse CLA
37-
* Use a valid commit record, including a signed-off-by entry.
38-
39-
There are further details at
40-
41-
- [Handling Git Contributions](https://wiki.eclipse.org/Development_Resources/Handling_Git_Contributions)
42-
43-
Once the patch is pushed back to Gerrit, the project committers will be
44-
informed and they will undertake a review of the code. The patch may need
45-
modifying for some reason. In order to make amending commits more
46-
straightforward, the steps at
47-
https://git.eclipse.org/r/Documentation/cmd-hook-commit-msg.html should be
48-
followed. This automatically inserts a "Change-Id" entry to your commit message
49-
which allows you to amend commits and have Gerrit track them as the same
50-
change.
5134

5235
What happens next depends on the content of the patch. If it is 100% authored
5336
by the contributor and is less than 1000 lines (and meets the needs of the
54-
project), then it can be committed to the main repository. If not, more steps
55-
are required. These are detailed in the
37+
project), then it can be pulled into the main repository. If not, more steps
38+
are required. These are detailed in the
5639
[legal process poster](http://www.eclipse.org/legal/EclipseLegalProcessPoster.pdf).
5740

5841

59-
Developer resources:
60-
--------------------
6142

62-
Information regarding source code management, builds, coding standards, and more.
43+
## Developer resources:
6344

64-
- [https://projects.eclipse.org/projects/iot.paho/developer](https://projects.eclipse.org/projects/iot.paho/developer)
6545

66-
Contributor License Agreement:
67-
------------------------------
46+
Information regarding source code management, builds, coding standards, and more.
6847

69-
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).
48+
- [https://projects.eclipse.org/projects/iot.paho/developer](https://projects.eclipse.org/projects/iot.paho/developer)
7049

7150
Contact:
7251
--------
7352

74-
Contact the project developers via the project's development
53+
Contact the project developers via the project's development
7554
[mailing list](https://dev.eclipse.org/mailman/listinfo/paho-dev).
7655

7756
Search for bugs:
7857
----------------
7958

80-
This project uses [Bugzilla](https://bugs.eclipse.org/bugs/buglist.cgi?product=Paho) to track ongoing development and issues.
59+
This project uses GitHub Issues here: [github.com/eclipse/paho.mqtt.c/issues](https://github.com/eclipse/paho.mqtt.c/issues) to track ongoing development and issues.
8160

8261
Create a new bug:
8362
-----------------
8463

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

87-
- [Create new Paho bug](https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Paho)
66+
- [Create new Paho bug](https://github.com/eclipse/paho.mqtt.c/issues/new)

NOTICE

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Notices for Eclipse Paho
2+
3+
This content is produced and maintained by the Eclipse Paho project.
4+
5+
* Project home: https://projects.eclipse.org/projects/iot.paho
6+
7+
## Trademarks
8+
9+
Paho™ is a trademark of the Eclipse Foundation.
10+
11+
## Copyright
12+
13+
All content is the property of the respective authors or their employers. For
14+
more information regarding authorship of content, please consult the listed
15+
source code repository logs.
16+
17+
## Declared Project Licenses
18+
19+
This program and the accompanying materials are made available under the terms
20+
of the Eclipse Public License v2.0 which is available at
21+
https://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
22+
v1.0 which is available at https://www.eclipse.org/org/documents/edl-v10.php.
23+
24+
SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
25+
26+
## Source Code
27+
28+
The project maintains the following source code repositories:
29+
30+
* https://github.com/eclipse/paho-website
31+
* https://github.com/eclipse/paho.golang
32+
* https://github.com/eclipse/paho.mqtt-sn.embedded-c
33+
* https://github.com/eclipse/paho.mqtt-spy
34+
* https://github.com/eclipse/paho.mqtt.android
35+
* https://github.com/eclipse/paho.mqtt.c
36+
* https://github.com/eclipse/paho.mqtt.cpp
37+
* https://github.com/eclipse/paho.mqtt.d
38+
* https://github.com/eclipse/paho.mqtt.embedded-c
39+
* https://github.com/eclipse/paho.mqtt.golang
40+
* https://github.com/eclipse/paho.mqtt.java
41+
* https://github.com/eclipse/paho.mqtt.javascript
42+
* https://github.com/eclipse/paho.mqtt.m2mqtt
43+
* https://github.com/eclipse/paho.mqtt.python
44+
* https://github.com/eclipse/paho.mqtt.ruby
45+
* https://github.com/eclipse/paho.mqtt.rust
46+
* https://github.com/eclipse/paho.mqtt.testing
47+
48+
## Cryptography
49+
50+
Content may contain encryption software. The country in which you are currently
51+
may have restrictions on the import, possession, and use, and/or re-export to
52+
another country, of encryption software. BEFORE using any encryption software,
53+
please check the country's laws, regulations and policies concerning the import,
54+
possession, or use, and re-export of encryption software, to see if this is
55+
permitted.

SECURITY.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Security Policy
2+
3+
This project follows the [Eclipse Vulnerability Reporting Policy](https://www.eclipse.org/security/policy.php).
4+
Vulnerabilities are tracked by the Eclipse security team, in cooperation with the project lead.
5+
Fixing vulnerabilities is taken care of by the project committers, with assistance and guidance of the security
6+
team.
7+
8+
## Supported Versions
9+
10+
Eclipse Paho provides security updates for the most recent version only.
11+
12+
## Reporting a Vulnerability
13+
14+
We recommend that in case of suspected vulnerabilities you do not create a GitHub issue, but instead contact the
15+
Eclipse Security Team directly sending an email to [email protected].
16+

0 commit comments

Comments
 (0)