From 5d98e0cad4592aa696e20512ad065e06d2976504 Mon Sep 17 00:00:00 2001 From: Humble Chirammal Date: Wed, 8 May 2019 11:54:39 +0530 Subject: [PATCH] Add PR/Issue/Feature templates Signed-off-by: Humble Chirammal --- .github/ISSUE_TEMPLATE/bug_report.md | 40 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 21 ++++++++++++ .github/pull_request_template.md | 31 ++++++++++++++++++ 3 files changed, 92 insertions(+) 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 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..fac7a3f2b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..a54424c64 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..1aa6fefd9 --- /dev/null +++ b/.github/pull_request_template.md @@ -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.