diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 5d11abd4..3fb28ae1 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,35 +1,2 @@ -# These owners will be the default owners for everything in -# the repo. -* @nolar @samurang87 - - - -# Samples for assigning codeowners below: -# Order is important; the last matching pattern takes the most -# precedence. When someone opens a pull request that only -# modifies JS files, only @js-owner and not the global -# owner(s) will be requested for a review. -# *.js @js-owner - -# You can also use email addresses if you prefer. They'll be -# used to look up users just like we do for commit author -# emails. -# *.go docs@example.com - -# In this example, @doctocat owns any files in the build/logs -# directory at the root of the repository and any of its -# subdirectories. -# /build/logs/ @doctocat - -# The `docs/*` pattern will match files like -# `docs/getting-started.md` but not further nested files like -# `docs/build-app/troubleshooting.md`. -# docs/* docs@example.com - -# In this example, @octocat owns any file in an apps directory -# anywhere in your repository. -# apps/ @octocat - -# In this example, @doctocat owns any file in the `/docs` -# directory in the root of your repository. -# /docs/ @doctocat +# Who is automatically assigned to the new PRs based on their content. +* @nolar diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 95470a35..0630ef31 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,21 +1,9 @@ -## Expected Behavior +## Long story short + -## Actual Behavior +## Description -## Steps to Reproduce the Problem - - 1. - 1. - 1. - -## Specifications - - - Platform: - - Kubernetes version: *(use `kubectl version`)* - - Python version: *(use `python --version`)* - - Python packages installed: *(use `pip freeze --all`)* - -``` -``` + diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..9f75eaf9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,58 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: 'bug' +assignees: '' + +--- +## Long story short + + + + +## Description + + + +
The code snippet to reproduce the issue + +```python +import kopf +``` +
+ +
The exact command to reproduce the issue + +```bash +kopf run ... +``` +
+ +
The full output of the command that failed + +``` +``` +
+ + +## Environment + + + +* Kopf version: +* Kubernetes version: +* Python version: +* OS/platform: + +
Python packages installed + + +``` +``` +
+ diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 00000000..0086358d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..c66852d4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,33 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: 'enhancement' +assignees: '' + +--- +## Problem + + + + + + +## Proposal + + + + + +```python +import kopf +``` + + + + +## Checklist + +- [ ] Many users can benefit from this feature, it is not a one-time case +- [ ] The proposal is related to the K8s operator framework, not to the K8s client libraries diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000..529ce722 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,24 @@ +--- +name: Question +about: Ask an advice on how to do something +title: '' +labels: 'question' +assignees: '' + +--- +## Question + + + + + + +## Checklist + +- [ ] I have read the [documentation](https://kopf.readthedocs.io/en/latest/) and searched there for the problem +- [ ] I have searched in the [GitHub Issues](https://github.com/zalando-incubator/kopf/issues?utf8=%E2%9C%93&q=) for similar questions + + +## Keywords + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 98ab29d1..62b9a854 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,27 +1,50 @@ -# One-line summary +## What do these changes do? + + -> Issue : #1234 (only if appropriate) ## Description -A few sentences describing the overall goals of the pull request's -commits. -## Types of Changes -_What types of changes does your code introduce? Keep the ones that apply:_ + + + + + + + + + + + + + +## Issues/PRs + + + +> Issues: + +> Related: + + +## Type of changes + + - New feature (non-breaking change which adds functionality) - Bug fix (non-breaking change which fixes an issue) -- Configuration change -- Refactor/improvements -- Documentation / non-code - -## Tasks -_List of tasks you will do to complete the PR_ - - [ ] Task 1 - - [ ] Task 2 - - [ ] Task 3 - -## Review -_List of tasks the reviewer must do to review the PR_ -- [ ] Tests -- [ ] Documentation +- Refactoring (non-breaking change which does not alter the behaviour) +- Mostly documentation and examples (no code changes) +- Mostly CI/CD automation, contribution experience + + +## Checklist + +- [ ] The code addresses only the mentioned problem, and this problem only +- [ ] I think the code is well written +- [ ] Unit tests for the changes exist +- [ ] Documentation reflects the changes +- [ ] If you provide code modification, please add yourself to `CONTRIBUTORS.txt` + + diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index 7b456d2f..117dce81 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -1,13 +1,15 @@ # Project Contributors -All external contributors to the project, we are grateful for all their help +All external contributors to the project, we are grateful for all their help. + +For the detailed information on who did what, see [GitHub Contributors](https://github.com/zalando-incubator/kopf/graphs/contributors) page. ## Contributors sorted alphabetically -- **[Name of contributor](https://github.com/user/name)** - - Contribution - - Contribution - -- **[Name of contributor](https://github.com/user/name)** - - Contribution - - Contribution +- [Daniel Middlecote](https://github.com/dlmiddlecote) +- [Henning Jacobs](https://github.com/hjacobs) +- [Ismail Kaboubi](https://github.com/smileisak) +- [Sergey Vasilyev](https://github.com/nolar) +- [Soroosh Sarabadani](https://github.com/psycho-ir) +- [Trond Hindenes](https://github.com/trondhindenes) +- [Vennamaneni Sai Narasimha](https://github.com/thevennamaneni) diff --git a/SECURITY.md b/SECURITY.md index 6a3ad59f..05773971 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -5,4 +5,4 @@ We host our bug bounty program on HackerOne, it is currently private, therefore https://corporate.zalando.com/en/services-and-contact#security-form -You can also send you report via this form if you do not want to join our bug bounty program and just want to report a vulnerability or security issue. +You can also send your report via this form if you do not want to join our bug bounty program and just want to report a vulnerability or security issue.