mirror of
https://github.com/ceph/ceph-csi.git
synced 2024-12-18 02:50:30 +00:00
Add PR/Issue/Feature templates
Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
This commit is contained in:
parent
5bebb7f8f5
commit
5d98e0cad4
40
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
40
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
---
|
||||||
|
name: Bug report
|
||||||
|
about: Create a report to help us improve
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# Describe the bug #
|
||||||
|
|
||||||
|
A clear and concise description of what the bug is.
|
||||||
|
|
||||||
|
# Environment details #
|
||||||
|
|
||||||
|
- Image/version of Ceph CSI driver
|
||||||
|
- helm chart version
|
||||||
|
- Kubernetes cluster version
|
||||||
|
- Logs
|
||||||
|
|
||||||
|
# Steps to reproduce #
|
||||||
|
|
||||||
|
Steps to reproduce the behavior:
|
||||||
|
|
||||||
|
1. Setup details: '...'
|
||||||
|
1. Deployment to trigger the issue '....'
|
||||||
|
1. See error
|
||||||
|
|
||||||
|
# Actual results #
|
||||||
|
|
||||||
|
Describe what happened
|
||||||
|
|
||||||
|
# Expected behavior #
|
||||||
|
|
||||||
|
A clear and concise description of what you expected to happen.
|
||||||
|
|
||||||
|
# Additional context #
|
||||||
|
|
||||||
|
Add any other context about the problem here.
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
Any existing bug report which describe about the similar issue/behavior
|
21
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
21
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
---
|
||||||
|
name: Feature request
|
||||||
|
about: Suggest an idea for this project
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# Describe the feature you'd like to have #
|
||||||
|
|
||||||
|
What new functionality do you want?
|
||||||
|
|
||||||
|
# What is the value to the end user? (why is it a priority?) #
|
||||||
|
|
||||||
|
How would the end user gain value from having this feature?
|
||||||
|
|
||||||
|
# How will we know we have a good solution? (acceptance criteria) #
|
||||||
|
|
||||||
|
Add a list of criteria that should be met for this feature to be useful
|
||||||
|
|
||||||
|
# Additional context #
|
||||||
|
|
||||||
|
Add any other context or screenshots about the feature request here.
|
31
.github/pull_request_template.md
vendored
Normal file
31
.github/pull_request_template.md
vendored
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
# Describe what this PR does #
|
||||||
|
|
||||||
|
Provide some context for the reviewer
|
||||||
|
|
||||||
|
## Is there anything that requires special attention ##
|
||||||
|
|
||||||
|
Do you have any questions?
|
||||||
|
|
||||||
|
Is the change backward compatible?
|
||||||
|
|
||||||
|
Are there concerns around backward compatibility?
|
||||||
|
|
||||||
|
Provide any external context for the change, if any.
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
* Kubernetes links that explain why the change is required
|
||||||
|
* CSI spec related changes/catch-up that necessitates this patch
|
||||||
|
* golang related practices that necessitates this change
|
||||||
|
|
||||||
|
## Related issues ##
|
||||||
|
|
||||||
|
Mention any github issues relevant to this PR. Adding below line
|
||||||
|
will help to auto close the issue once the PR is merged.
|
||||||
|
|
||||||
|
Fixes: #issue_number
|
||||||
|
|
||||||
|
## Future concerns ##
|
||||||
|
|
||||||
|
List items that are not part of the PR and do not impact it's
|
||||||
|
functionality, but are work items that can be taken up subsequently.
|
Loading…
Reference in New Issue
Block a user