From 679bf2c4cde4063991f45f257dad53571233d92e Mon Sep 17 00:00:00 2001 From: Gregor Noczinski Date: Thu, 21 Dec 2023 11:11:11 +0100 Subject: [PATCH] Better documentation --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++ .github/ISSUE_TEMPLATE/feature_request.md | 21 ++++ .github/pull_request_template.md | 16 +++ CODE_OF_CONDUCT.md | 128 ++++++++++++++++++++++ CONTRIBUTING.md | 43 ++++++++ README.md | 10 +- 6 files changed, 249 insertions(+), 7 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/pull_request_template.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..8852146 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '[BUG] ' +labels: 'bug new_feature' +assignees: '' +--- + +## Environment + +### lingress +* Version: +* OS: +* Helm chart version (if applicable): +* Kubernetes version: + +### Client +* Browser: +* Version: +* OS: + +## Describe the bug + + +## Steps to reproduce +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +## Expected behavior + + +## Screenshots + + +## Additional context + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..95db8e6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,21 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '[FEATURE]' +labels: 'new new_feature' +assignees: '' +--- + +## Is your feature request related to a problem? Please describe. + + +Ex. I'm always frustrated when [...] + +## Describe the solution you'd like + + +## Describe alternatives you've considered + + +## Additional context + \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..c7009e9 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,16 @@ +--- +name: Pull Request +about: Provide us new changes, made by you. +title: '' +labels: 'new' +assignees: '' +--- + +## References +* Issue(s): + +## Motivation + + +## Changes + diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..bf2ec57 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# 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 +* 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 +[contact@echocat.org](mailto:contact@echocat.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 +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +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 +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..06eed4d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,43 @@ +# Contributing Guidelines + +Contributions are welcome via [GitHub Pull Requests](https://docs.github.com/articles/about-pull-requests). This document outlines the process to help get your contribution accepted. + +Any type of contribution is welcome; from new features, bug fixes, or documentation improvements. However, [echocat](https://echocat.org) will review the proposals and perform a triage over them. By doing so, we will ensure that the most valuable contributions for the community will be implemented in due time. + +## How to Contribute + +1. [Fork this repository]((https://github.com/echocat/lingress/fork)), develop, and test your changes. +2. [Submit a pull request](https://docs.github.com/articles/creating-a-pull-request). + +### Technical Requirements + +When submitting a PR make sure that it: + +- Must pass CI jobs/actions. +- Must follow [Golang best practices](https://go.dev/doc/effective_go). +- Is signed off with the line `Signed-off-by: `. [Learn more about signing off on commits](https://docs.github.com/en/organizations/managing-organization-settings/managing-the-commit-signoff-policy-for-your-organization). + > [!Note] + > Signing off on a commit is different from signing a commit, such as with a GPG key. + +### PR Approval + +1. Changes are manually reviewed by [echocat](https://echocat.org) team members. +2. When the PR passes all tests, the PR is merged by the reviewer(s) in the GitHub [`main` branch](https://github.com/echocat/lingress/tree/main). + +### Release process + +#### Schedule + +There are no fixed cycles for releases. Currently, they are triggered as soon bugfixes, security updates or main features arriving. + +#### Creation + +First of all, prepare the release notes as usual, and merge them. + +Once the release notes are ready, a release train is launched by *tagging* from `main` to `vX.Y.Z`. + +#### Validation + +The `vX.Y.Z` tag will go through the release CI. + +If anything fails the release tag is dropped, the issue fixed in `main` and a new release train is started on a new tag. diff --git a/README.md b/README.md index 1380b24..3960759 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,9 @@ In contrast to the most other ingress controllers for Kubernetes, this one does 4. [Configuration](doc/configuration.md) ➡️ 5. [Headers](doc/headers.md) ➡️ 6. [Examples](doc/examples.md) ➡️ -7. [Contributing](#contributing) -8. [License](#license) +7. [Contributing](CONTRIBUTING.md) ➡️ +8. [Code of Conduct](CODE_OF_CONDUCT.md) ➡️ +9. [License](LICENSE) ➡️ ## Main principles @@ -38,11 +39,6 @@ by [fork us](https://github.com/echocat/lingress/fork). If you commit code to this project, you have to accept that this code will be released under the [license](#license) of this project. -## License - -See the [LICENSE](LICENSE) file. - - ## More topics * [Setup](doc/setup.md) * [Configuration](doc/configuration.md)