From 6b90a6299a5f2b9d3d184b9d6f418cd11889035c Mon Sep 17 00:00:00 2001 From: Mihir Soni Date: Mon, 22 Mar 2021 09:32:45 -0700 Subject: [PATCH] [CI] Adding Github Issue / PR templates (#206) * [CI] Adding Github Issue / PR templates Signed-off-by: Mihir Soni * [CI] Addressed review comments Signed-off-by: Mihir Soni --- .github/ISSUE_TEMPLATE/bug_template.md | 43 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_template.md | 23 ++++++++++ .../pull_request_template.md | 12 ++++++ 3 files changed, 78 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_template.md create mode 100644 .github/ISSUE_TEMPLATE/feature_template.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_template.md b/.github/ISSUE_TEMPLATE/bug_template.md new file mode 100644 index 000000000000..6409a8e16396 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_template.md @@ -0,0 +1,43 @@ +--- +name: 🐛 Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: bug +assignees: '' +--- + +**Describe the bug** + +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**OpenSearch Version** +Please list the version of OpenSearch being used. + +**Dashboards Version** +Please list the version of OpenSearch Dashboards being used. + +**Plugins** + +Please list all plugins currently enabled. + +**Screenshots** + +If applicable, add screenshots to help explain your problem. + +**Host/Environment (please complete the following information):** + - OS: [e.g. iOS] + - Browser and version [e.g. 22] + +**Additional context** + +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_template.md b/.github/ISSUE_TEMPLATE/feature_template.md new file mode 100644 index 000000000000..7bf23d90eda3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_template.md @@ -0,0 +1,23 @@ +--- +name: 🎆 Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' +--- + +**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 solution 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. + +**Additional context** + +Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 000000000000..8dfac58be91d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,12 @@ +### Description +[Describe what this change achieves] + +### Issues Resolved +[List any issues this PR will resolve] + +### Check List +- [ ] New functionality includes testing. + - [ ] All tests pass +- [ ] New functionality has been documented. + - [ ] New functionality has javadoc added +- [ ] Commits are signed per the DCO using --signoff \ No newline at end of file