-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add legal documents and update README.md for that
Added: - CODE_OF_CONDUCT.md - CONTRIBUTING.MD - NOTICE.md - SECURITY.md Updated: - README.md Signed-off-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
- Loading branch information
Showing
5 changed files
with
215 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Community Code of Conduct | ||
|
||
**Version 1.2 | ||
August 19, 2020** | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as community members, contributors, committers, and project leaders pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
||
## Our Responsibilities | ||
|
||
With the support of the Eclipse Foundation staff (the “Staff”), project committers and leaders are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. | ||
|
||
Project committers and leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the Eclipse Foundation project or its community in public spaces. Examples of representing a project or community include posting via an official social media account, or acting as a project representative at an online or offline event. Representation of a project may be further defined and clarified by project committers, leaders, or the EMO. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the Staff at codeofconduct@eclipse.org. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The Staff is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. | ||
|
||
Project committers or leaders who do not follow the Code of Conduct in good faith may face temporary or permanent repercussions as determined by the Staff. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org) , version 1.4, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct/) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
# Contributing to Trace Compass Test Traces | ||
|
||
Thanks for your interest in this project. | ||
|
||
## How to Contribute | ||
|
||
In order to contribute, please first [open an issue][issues] that clearly describes the bug you | ||
intend to fix or the feature you would like to add. | ||
|
||
Once you have your code ready for review, please [open a pull request][pull-requests]. Please follow | ||
the [pull request guidelines][pr-guide]. A committer of the Trace Comass project will then review your | ||
contribution and help to get it merged. | ||
|
||
## Terms of Use | ||
|
||
This repository is subject to the [Terms of Use of the Eclipse Foundation][terms] | ||
|
||
## Code of Conduct | ||
|
||
This project is governed by the [Eclipse Community Code of Conduct][code-of-conduct]. | ||
By participating, you are expected to uphold this code. | ||
|
||
## Eclipse Development Process | ||
|
||
This Eclipse Foundation open project is governed by the [Eclipse Foundation | ||
Development Process][dev-process] and operates under the terms of the [Eclipse IP Policy][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)][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][commiter-handbook]. | ||
|
||
## Adding a new test trace (CTF or Ftrace) | ||
|
||
Note the description below describes the procedure for CTF. For Ftrace, the | ||
procedure is the same. Just replace `ctf` with `ftrace` and `Ctf` with `Ftrace` | ||
respectively. | ||
|
||
The modules follow the [Maven standard directory layout][]. | ||
|
||
To add a new CTF test trace, add it to the `ctf/src/main/resources` directory. | ||
Make sure it is not archived or anything, as this will be exposed as-is to the | ||
users. | ||
|
||
Then update the `ctf/src/main/java/.../CtfTestTrace.java` file accordingly to | ||
include the new trace. | ||
|
||
Make sure the parameters (event count, etc.) are correct! This project does not | ||
check those at the moment, but if they are incorrect they **will** fail some | ||
Trace Compass unit tests. This is a known issue. | ||
|
||
Finally, bump the project's minor version (1.7.0 -> 1.8.0) in the main pom.xml | ||
and related `<parent>` blocks. | ||
|
||
## Pull request guidelines | ||
|
||
**Changes to the project** are made by submitting code with a pull request (PR). | ||
|
||
* [How to write and submit changes][creating-changes] | ||
|
||
**Good commit messages** make it easier to review code and understand why the changes were made. | ||
Please include a: | ||
|
||
* *Title:* Concise and complete title written in imperative (e.g. "Update Gitpod demo screenshots" | ||
or "Single-click to select or open trace") | ||
* *Problem:* What is the situation that needs to be resolved? Why does the problem need fixing? | ||
Link to related issues | ||
* *Solution:* What changes were made to resolve the situation? Why are these changes the right fix? | ||
* *Impact:* What impact do these changes have? (e.g. Numbers to show a performance improvement, | ||
screenshots or a video for a UI change) | ||
|
||
Other commit information: | ||
|
||
* [How to format the message][commit-message-message] | ||
|
||
## Contact | ||
|
||
For issues related to the Trace Compass test traces, please open a GitHub tracker for the [Trace Compass Test Traces][test-traces] or send an email to the [Trace Compass mailing list][mailing-list]. | ||
|
||
[code-of-conduct]: https://github.com/eclipse/.github/blob/master/CODE_OF_CONDUCT.md | ||
[commit-message-message]: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html | ||
[commiter-handbook]: https://www.eclipse.org/projects/handbook/#resources-commit | ||
[contact-us]: #contact | ||
[creating-changes]: https://www.dataschool.io/how-to-contribute-on-github/ | ||
[dev-process]: https://eclipse.org/projects/dev_process | ||
[eca]: http://www.eclipse.org/legal/ECA.php | ||
[ip-policy]: https://www.eclipse.org/org/documents/Eclipse_IP_Policy.pdf | ||
[issues]: https://github.com/eclipse-tracecompass/tracecompass-test-traces/issues | ||
[mailing-list]: https://accounts.eclipse.org/mailing-list/tracecompass-dev | ||
[pr-guide]: #pull-request-guidelines | ||
[pull-requests]: https://github.com/eclipse-tracecompass/tracecompass-test-traces/pulls | ||
[terms]: https://www.eclipse.org/legal/termsofuse.php | ||
[test-traces]: https://github.com/eclipse-tracecompass/tracecompass-test-traces |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# Notices for Eclipse Trace Compass - Test Traces Repository | ||
|
||
This content is produced and maintained by the Eclipse Trace Compass project. | ||
|
||
* Project home: https://projects.eclipse.org/projects/tools.tracecompass | ||
|
||
## Trademarks | ||
|
||
Eclipse Trace Compass, and Trace Compass are trademarks of the Eclipse | ||
Foundation. | ||
|
||
## Copyright | ||
|
||
All content is the property of the respective authors or their employers. For | ||
more information regarding authorship of content, please consult the listed | ||
source code repository logs. | ||
|
||
## Declared Project Licenses | ||
|
||
This program and the accompanying materials are made available under the terms | ||
of the Eclipse Public License v. 2.0 which is available at | ||
https://www.eclipse.org/legal/epl-2.0. | ||
|
||
SPDX-License-Identifier: EPL-2.0 | ||
|
||
## Source Code | ||
|
||
The project maintains the following source code repositories: | ||
|
||
* https://github.com/eclipse-tracecompass/tracecompass-test-traces | ||
|
||
## Third-party Content | ||
|
||
This project leverages the following third party content. | ||
|
||
None | ||
|
||
## Cryptography | ||
|
||
Content may contain encryption software. The country in which you are currently | ||
may have restrictions on the import, possession, and use, and/or re-export to | ||
another country, of encryption software. BEFORE using any encryption software, | ||
please check the country's laws, regulations and policies concerning the import, | ||
possession, or use, and re-export of encryption software, to see if this is | ||
permitted. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Security Policy | ||
|
||
This project implements the Eclipse Foundation Security Policy | ||
|
||
* https://www.eclipse.org/security | ||
|
||
## Reporting a Vulnerability | ||
|
||
Please report vulnerabilities to the Eclipse Foundation Security Team at | ||
security@eclipse.org |