This repository has been archived by the owner on Sep 14, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 87
Improve the GitHub issues/prs templates #278
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,9 @@ | ||
## Expected Behavior | ||
## Long story short | ||
|
||
<!-- Please describe the issue in 1-3 sentences. --> | ||
|
||
## 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`)* | ||
|
||
``` | ||
``` | ||
<!-- Please provide as much information as possible. | ||
Lack of information may result in a delayed response. Thank you! --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: 'bug' | ||
assignees: '' | ||
|
||
--- | ||
## Long story short | ||
|
||
<!-- Please describe your problem in 1-3 sentences. What has happened? What has not happened, but should have? --> | ||
|
||
|
||
## Description | ||
|
||
<!-- Please provide as much information as possible. Lack of information may result in a delayed response. As a guideline, use the following placeholders, and add yours as needed. --> | ||
|
||
<details><summary>The code snippet to reproduce the issue</summary> | ||
|
||
```python | ||
import kopf | ||
``` | ||
</details> | ||
|
||
<details><summary>The exact command to reproduce the issue</summary> | ||
|
||
```bash | ||
kopf run ... | ||
``` | ||
</details> | ||
|
||
<details><summary>The full output of the command that failed</summary> | ||
|
||
``` | ||
``` | ||
</details> | ||
|
||
|
||
## Environment | ||
|
||
<!-- The following commands can help: | ||
`kopf --version` or `pip show kopf` | ||
`kubectl version` | ||
`python --version` | ||
--> | ||
|
||
* Kopf version: | ||
* Kubernetes version: | ||
* Python version: | ||
* OS/platform: | ||
|
||
<details><summary>Python packages installed</summary> | ||
<!-- use `pip freeze --all` --> | ||
|
||
``` | ||
``` | ||
</details> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
blank_issues_enabled: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: 'enhancement' | ||
assignees: '' | ||
|
||
--- | ||
## Problem | ||
|
||
<!-- What problem do you currently face so that you want this feature? --> | ||
|
||
<!-- Are there existing features close to solving this problem? Why don't they work? --> | ||
|
||
|
||
## Proposal | ||
|
||
<!-- Describe the solution you would like to have. --> | ||
|
||
<!-- Provide a code snippet showing the new feature in action, at least as an idea. --> | ||
|
||
```python | ||
import kopf | ||
``` | ||
|
||
<!-- Are there any other ways of achieving the same goal? | ||
Why is this proposal better than those alternatives? --> | ||
|
||
|
||
## 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
name: Question | ||
about: Ask an advice on how to do something | ||
title: '' | ||
labels: 'question' | ||
assignees: '' | ||
|
||
--- | ||
## Question | ||
|
||
<!-- What problem do you currently face and see no solution for it? --> | ||
|
||
<!-- If possible, explain what other ways did you try to solve the problem? --> | ||
|
||
|
||
## 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 | ||
|
||
<!-- Which keywords did you search for in the documentation/issue for this problem? --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,50 @@ | ||
# One-line summary | ||
## What do these changes do? | ||
|
||
<!-- Please give a short brief about these changes (1-3 sentences). --> | ||
|
||
> 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:_ | ||
<!-- What was the previous behaviour before the PR is merged? --> | ||
|
||
<!-- What will be the new behaviour after the PR is merged? --> | ||
|
||
<!-- A code snippet showing the new features added (if any)? --> | ||
|
||
<!-- Does the change affect the end users or is it internal? --> | ||
|
||
<!-- Why have you decided to solve the problem this way? What were the trade-offs? (If appropriate.) --> | ||
|
||
<!-- Are there any breaking or risky changes? --> | ||
|
||
|
||
## Issues/PRs | ||
|
||
<!-- Cross-referencing is highly useful in hindsight. Put the main issue, and all the related/affected/causing/preceding issues and PRs related to this change. --> | ||
|
||
> Issues: | ||
|
||
> Related: | ||
|
||
|
||
## Type of changes | ||
|
||
<!-- Remove the irrelevant items. Keep only those that reflect the main purpose of the change. --> | ||
|
||
- 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` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "modifications" |
||
|
||
<!-- Are there any questions or uncertainties left? | ||
Any tasks that have to be done to complete the PR? --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I could use this line for myself lol