diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..fe1eb30 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,80 @@ +# 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, 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 +- Contacting individual members, contributors, or leaders privately, outside designated community mechanisms, 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 coc@interledger.org. 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.0, available at . + +Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at . Translations are available at . diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..f06e702 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,74 @@ +# Contributing to this repository + +Thank you for contributing to Helm Charts :tada: Your contributions are essential to making this project better. + +## Getting Started + +- Have you read the [code of conduct](CODE_OF_CONDUCT.md)? +- Check out the [existing issues](https://github.com/interledger/helm-charts/issues) & see if we [accept contributions](#types-of-contributions) for your type of issue. + +## Table of Contents + +- [Types of contributions](#types-of-contributions) + - [:beetle: Issues](#beetle-issues) + - [:hammer_and_wrench: Pull requests](#hammer_and_wrench-pull-requests) +- [Working in the Helm Charts repository](#working-in-the-helm-charts-repository) + - [CI](#ci) + - [Reporting Issues](#reporting-issues) + - [Submitting Pull Requests](#submitting-pull-requests) + - [Review Process](#review-process) + +### Types of contributions + +You can contribute to Helm Charts in several ways. + +#### :beetle: Issues + +We use GitHub issues to track tasks that contributors can help with. We haven't finalized labels yet for contributors to tackle. If you want to help with work related to an issue, please comment on the issue before starting work on it. + +If you've found something that needs fixing, search open issues to see if someone else has reported the same thing. If it's something new, open an issue. We'll use the issue to discuss the problem you want to fix. + +#### :hammer_and_wrench: Pull requests + +Feel free to fork and create a pull request on changes you think you can contribute. + +The team will review your pull request as soon as possible. + +### Working in the Helm Charts repository + +This project uses [helm](https://helm.sh/). Please refer to Helm's [documentation](https://helm.sh/docs/) to get started.. + +#### CI + +We use GitHub actions to manage our CI pipeline. + +The workflows can be found in `.github/workflows` + +### Reporting Issues + +If you encounter any issues or have a feature request, please [create a new issue](https://github.com/interledger/helm-charts/issues/new/choose) and provide the following details: + +- A clear and descriptive title. +- A detailed description of the issue, including steps to reproduce if applicable. +- Information about your environment (e.g., operating system, browser, version). +- Any relevant screenshots or error messages. + +### Submitting Pull Requests + +1. [Fork](https://github.com/interledger/helm-charts) the repository. +2. Create a new branch from `main`. +3. Make your changes and commit them. +4. Create a pull request (PR) to `main`. +5. Ensure your PR includes a clear title and description following the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/). +6. If your PR addresses an issue, reference the issue in the description using `Closes #123`. +7. Be patient and be prepared to address feedback and make changes if needed. + +### Review Process + +- Project maintainers will review your PR for code quality, correctness, and adherence to guidelines. +- Please respond to any feedback promptly and make necessary changes. +- Once the PR is approved, it will be merged into the main branch. + +Thank you for contributing to Helm Charts! We appreciate your time and effort in helping make the Extension better. Join our community on [Slack](https://communityinviter.com/apps/interledger/interledger-working-groups-slack) to connect with other contributors and stay updated on project developments. + +Happy coding!