Community Standards

* add Code of conduct, contributing and security document
* add Getting Help section to the README

Signed-off-by: Jeff Mesnil <jmesnil@redhat.com>

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+
+# 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 leader responsible for enforcement at lthon@redhat.com.
+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

CONTRIBUTING.md

@@ -0,0 +1,69 @@
+# Contributing guide
+
+**Want to contribute? Great!** 
+We try to make it easy, and all contributions, even the smaller ones, are more than welcome.
+This includes bug reports, fixes, documentation, examples... 
+But first, read this page (including the small print at the end).
+
+## Legal
+
+All original contributions to Jandex licensed under the
+[ASL - Apache License](https://www.apache.org/licenses/LICENSE-2.0),
+version 2.0 or later, or, if another license is specified as governing the file or directory being
+modified, such other license.
+
+## Reporting an issue
+
+This project uses GitHub issues to manage the issues. 
+Open an issue directly in [GitHub](https://github.com/smallrye/jandex/issues).
+
+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.
+Don't forget to indicate your Jandex, Java, and Maven/Gradle version. 
+
+## Before you contribute
+
+To contribute, use GitHub Pull Requests, from your **own** fork.
+
+### Code reviews
+
+All non-trivial contributions, including contributions by project members, need to be reviewed before being merged.
+
+### Continuous Integration
+
+Because we are all humans, the project uses a continuous integration approach and each pull request triggers a full build.
+Please make sure to monitor the output of the build and act accordingly.
+
+Jandex uses GitHub Actions as CI, so you can see the progress and results in the _checks_ tab of your pull request.
+Follow the results on https://github.com/smallrye/jandex/actions.
+
+### Tests and documentation are not optional
+
+Don't forget to include tests in your pull requests. 
+Also don't forget the documentation (reference documentation, javadoc...).
+
+We even accept pull requests just containing tests or documentation.
+
+## Setup
+
+If you have not done so on this machine, you need to:
+
+* Install Git and configure your GitHub access
+* Install Java SDK (OpenJDK recommended, see https://adoptium.net/)
+* Install Apache Maven (or use the `mvnw` wrapper scripts instead of `mvn`)
+
+## Build
+
+* Clone the repository: `git clone https://github.com/smallrye/jandex.git`
+* Navigate to the directory: `cd jandex`
+* Invoke `mvn clean install` from the root directory
+
+```bash
+git clone https://github.com/smallrye/jandex.git
+cd smallrye-mutiny
+mvn clean install
+# Wait... success!
+```
+
+## The small print
+
+This project is an open source project, please act responsibly, be nice, polite and enjoy!

README.md

@@ -2,3 +2,9 @@
 
 Jandex is a space efficient Java class file indexer and offline reflection library.
 See the [documentation](https://smallrye.io/jandex/).
+
+# Getting Help
+
+Issues can be reported in [GitHub Issues](https://github.com/smallrye/jandex/issues).
+
+For discussions, use the [SmallRye Google Group](https://groups.google.com/g/smallrye) or the [Quarkus Zulip chat](https://quarkusio.zulipchat.com/).

SECURITY.md

@@ -0,0 +1,11 @@
+# Security Policy
+
+## Security Contacts and Procedures
+
+The Jandex community takes security very seriously, and we aim to take immediate action to address serious security-related problems that involve our products or services.
+
+Please report any suspected security vulnerability in this project to Red Hat Product Security at secalert@redhat.com. You can use our GPG key to communicate with us securely.
+
+To report an issue in any Red Hat branded website or online service, please contact Red Hat Information Security at site-security@redhat.com.
+
+https://access.redhat.com/security/team/contact