Skip to content

Commit

Permalink
Update Issue and PR templates (opensearch-project#1196)
Browse files Browse the repository at this point in the history
* Update Issue and PR templates

Reduce and clarify instructions on issues and pr templates

Signed-off-by: Peter Nied <[email protected]>
  • Loading branch information
peternied authored Dec 12, 2024
1 parent ac5dd29 commit 0dd78b3
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 11 deletions.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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._
15 changes: 4 additions & 11 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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?
<!-- Describe what this change achieves -->

### Issues Resolved
[List any issues this PR will resolve]

Is this a backport? If so, please add backport PR # and/or commits #
<!-- List any GitHub or Jira issues this PR will resolve -->

### Testing
[Please provide details of testing done: unit testing, integration testing and manual 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).

0 comments on commit 0dd78b3

Please sign in to comment.