-
Notifications
You must be signed in to change notification settings - Fork 499
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add GitHub templates for issue reporting and PR #420
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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
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,26 @@ | ||
--- | ||
name: "\U0001F41B Bug Report" | ||
about: Something isn't working as expected | ||
|
||
--- | ||
|
||
## Bug Report | ||
|
||
**What version of Kubernetes are you using?** | ||
<!-- You can run `kubectl version` --> | ||
|
||
**What version of TiDB Operator are you using?** | ||
<!-- You can run `kubectl exec -n tidb-admin {tidb-controller-manager-pod-name} -- tidb-controller-manager -V` --> | ||
|
||
**What storage classes exist in the Kubernetes cluster and what are used for PD/TiKV pods?** | ||
<!-- You can run `kubectl get sc` and `kubectl get pvc -n {tidb-cluster-namespace}` --> | ||
|
||
**What's the status of the TiDB cluster pods?** | ||
<!-- You can run `kubectl get po -n {tidb-cluster-namespace} -o wide` --> | ||
|
||
**What did you do?** | ||
<!-- If possible, provide a recipe for reproducing the error. How you installed tidb-operator and tidb-cluster. --> | ||
|
||
**What did you expect to see?** | ||
|
||
**What did you see instead?** |
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,19 @@ | ||
--- | ||
name: "\U0001F680 Feature Request" | ||
about: I have a suggestion | ||
|
||
--- | ||
|
||
## Feature Request | ||
|
||
**Is your feature request related to a problem? Please describe:** | ||
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] --> | ||
|
||
**Describe the feature you'd like:** | ||
<!-- A clear and concise description of what you want to happen. --> | ||
|
||
**Describe alternatives you've considered:** | ||
<!-- A clear and concise description of any alternative solutions or features you've considered. --> | ||
|
||
**Teachability, Documentation, Adoption, Migration Strategy:** | ||
<!-- If you can, explain some scenarios how users might use this, situations it would be helpful in. Any API designs, mockups, or diagrams are also helpful. --> |
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,15 @@ | ||
--- | ||
name: "\U0001F914 Question" | ||
about: Usage question that isn't answered in docs or discussion | ||
|
||
--- | ||
|
||
## Question | ||
|
||
Before asking a question, make sure you have: | ||
|
||
- Reviewed relevant Kubernetes information: Google your error messages and look at K8s docs. | ||
- Searched open and closed [GitHub issues](https://github.com/pingcap/tidb-operator/issues?utf8=%E2%9C%93&q=is%3Aissue) | ||
- Read the documentation: | ||
- [TiDB Operator Readme](https://github.com/pingcap/tidb-operator) | ||
- [TiDB Operator Doc](https://github.com/pingcap/tidb-operator/tree/master/docs) | ||
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,32 @@ | ||
<!-- | ||
Thank you for contributing to TiDB Operator! Please read TiDB Operator's [CONTRIBUTING](https://github.com/pingcap/tidb-operator/blob/master/CONTRIBUTING.md) document **BEFORE** filing this PR. | ||
--> | ||
|
||
### What problem does this PR solve? <!--add issue link with summary if exists--> | ||
tennix marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### What is changed and how it works? | ||
|
||
### Check List <!--REMOVE the items that are not applicable--> | ||
|
||
Tests <!-- At least one of them must be included. --> | ||
|
||
- Unit test | ||
- E2E test | ||
tennix marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- Manual test (add detailed scripts or steps below) | ||
- No code | ||
|
||
Code changes | ||
|
||
- Has Helm charts change | ||
- Has Go code change | ||
- Has CI related scripts change | ||
- Has documents change | ||
|
||
Side effects | ||
|
||
- Breaking backward compatibility | ||
|
||
Related changes | ||
|
||
- Need to cherry-pick to the release branch | ||
- Need to update the documentation |
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.
This is being moved soon?
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.
Yes, we'll recently move our documents to https://github.com/pingcap/docs and https://github.com/pingcap/docs-cn to make our documents available on PingCAP official website.
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.
Then this link will break?
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.
We should update the links when our documents are all moved to the pingcap/docs and pingcap/docs-cn.