From 0dd78b3919931dfadead9be907c2cfba0b826b43 Mon Sep 17 00:00:00 2001 From: Peter Nied Date: Thu, 12 Dec 2024 14:30:38 -0600 Subject: [PATCH] Update Issue and PR templates (#1196) * Update Issue and PR templates Reduce and clarify instructions on issues and pr templates Signed-off-by: Peter Nied --- .github/ISSUE_TEMPLATE/BUG_TEMPLATE.md | 21 +++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 15 ++++----------- 2 files changed, 25 insertions(+), 11 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/BUG_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/BUG_TEMPLATE.md b/.github/ISSUE_TEMPLATE/BUG_TEMPLATE.md new file mode 100644 index 000000000..4a1c510f9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_TEMPLATE.md @@ -0,0 +1,21 @@ +--- +name: 🐛 Bug Report +about: Create a report to help us improve +title: '[BUG]' +labels: 'bug, untriaged' +assignees: '' +--- +### What is the bug? +_A clear and concise description of the bug._ + +### What are your migration environments? +_What versions of Elasticsearch / Opensearch, what version of the Migration Assistant._ + +### How can one reproduce the bug? +_Steps to reproduce the behavior._ + +### What is the expected behavior? +_A clear and concise description of what you expected to happen._ + +### Do you have any additional context? +_Add any other context about the problem, such as log files our console output._ \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 014187aea..35d4dc1be 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,22 +1,15 @@ ### Description -[Describe what this change achieves] -* Category (Enhancement, New feature, Bug fix, Test fix, Refactoring, Maintenance, Documentation) -* Why these changes are required? -* What is the old behavior before changes and new behavior after changes? + ### Issues Resolved -[List any issues this PR will resolve] - -Is this a backport? If so, please add backport PR # and/or commits # + ### Testing -[Please provide details of testing done: unit testing, integration testing and manual testing] + ### Check List - [ ] New functionality includes testing - - [ ] All tests pass, including unit test, integration test and doctest -- [ ] New functionality has been documented -- [ ] Commits are signed per the DCO using --signoff +- [ ] Public documentation issue/PR [created](https://github.com/opensearch-project/documentation-website/issues/new/choose), if applicable. By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. For more information on following Developer Certificate of Origin and signing off your commits, please check [here](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).