diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..e454986 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1 @@ +* @resteasy/reviewers \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..dee1f2d --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,133 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community 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, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +James Perkins , Ron Sigal , +Rebecca Searls , Jim Ma and/or Li Wei Nan . +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations \ No newline at end of file diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc new file mode 100644 index 0000000..d970ba7 --- /dev/null +++ b/CONTRIBUTING.adoc @@ -0,0 +1,69 @@ +:toc: + += Contributing Guide + +Want to contribute to the RESTEasy? We try to make it easy, and all contributions, even the smaller ones, +are more than welcome. This includes bug reports, fixes, documentation, etc. First though, please read this page +(including the small print at the end). + +== Legal + +All original contributions to RESTEasy MicroProfile are licensed under the +https://www.apache.org/licenses/LICENSE-2.0[ASL - Apache License], version 2.0 or later, or, if another license is +specified as governing the file or directory being modified, such other license. + +All contributions are subject to the https://developercertificate.org/[Developer Certificate of Origin (DCO)]. +The DCO text is also included verbatim in the [dco.txt](dco.txt) file in the root directory of the repository. + +== Reporting an issue + +This project uses https://github.com/resteasy/resteasy-microprofile/issues[GitHub Issues] for filing issues. You can +also open a https://github.com/resteasy/resteasy-microprofile/discussions[discussion] if you feel if you have a question +on whether the issue you are seeing is a bug or not. + +If you believe you found a bug, and it's likely possible, please indicate a way to reproduce it, what you are seeing and +what you would expect to see. + +== Before you contribute + +To contribute, use GitHub Pull Requests, from your **own** fork. + +Also, make sure you have set up your Git authorship correctly: + +---- +git config --global user.name "Your Full Name" +git config --global user.email your.email@example.com +---- + +If you use different computers to contribute, please make sure the name is the same on all your computers. + +We use this information to acknowledge your contributions in release announcements. + +== Setup + +If you have not done so on this machine, you need to: + +* Install Git and configure your GitHub access +* Install Java JDK 11+ (OpenJDK recommended) + +=== IDE Config and Code Style + +RESTEasy has a strictly enforced code style. Code formatting is done by the Eclipse code formatter, using the config files +found in the https://github.com/resteasy/resteasy-dev-tools/tree/main/ide-config/src/main/resources[eclipse-code-formatter.xml] +file. By default, when you run `./mvnw install`, the code will be formatted automatically. +When submitting a pull request the CI build will fail if running the formatter results in any code changes, so it is +recommended that you always run a full Maven build before submitting a pull request. + +If you want to run the formatting without doing a full build, you can run `./mvnw process-sources`. + +==== Eclipse Setup + +Open the *Preferences* window, and then navigate to _Java_ -> _Code Style_ -> _Formatter_. Click _Import_ and then +select the `eclipse-code-formatter.xml` downloaded from the above link or clone the repository and navigate to the file. + +Next navigate to _Java_ -> _Code Style_ -> _Organize Imports_. Click _Import_ and select the `eclipse.importorder` file. + +==== IDEA Setup + +Install the https://plugins.jetbrains.com/plugin/6546-adapter-for-eclipse-code-formatter/[Adapter for Eclipse Code Formatter]. +See the https://github.com/krasa/EclipseCodeFormatter#instructions[documentation] on how to configure the plugin. \ No newline at end of file diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..9c8895e --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,21 @@ +# Reporting of CVEs and Security Issues + +## The RESTEasy community and our sponsor, Red Hat, take security bugs very seriously + +We aim to take immediate action to address serious security-related problems that involve our projects. + +## Reporting of Security Issues + +When reporting a security vulnerability it is important to not accidentally broadcast to the world that the issue exists, as this makes it easier for people to exploit it. The software industry uses the term embargo to describe the time a security issue is known internally until it is public knowledge. + +Our preferred way of reporting security issues in RESTEasy and its related projects is listed below. + +### Email the mailing list + +The list at resteasy-security@redhat.com is the preferred mechanism for outside users to report security issues. A member of the RESTEasy team will open the required issues. + +### Other considerations + +If you would like to work with us on a fix for the security vulnerability, please include your GitHub username in the above email, and we will provide you access to a temporary private fork where we can collaborate on a fix without it being disclosed publicly, **including in your own publicly visible git repository**. + +Do not open a public issue, send a pull request, or disclose any information about the suspected vulnerability publicly, **including in your own publicly visible git repository**. If you discover any publicly disclosed security vulnerabilities, please notify us immediately through resteasy-security@redhat.com diff --git a/dco.txt b/dco.txt new file mode 100644 index 0000000..8201f99 --- /dev/null +++ b/dco.txt @@ -0,0 +1,37 @@ +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. +1 Letterman Drive +Suite D4700 +San Francisco, CA, 94129 + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved.