Skip to content

Commit

Permalink
Rewrite the issue/pull request template of RocketMQ (#6645)
Browse files Browse the repository at this point in the history
  • Loading branch information
aaron-ai committed Apr 26, 2023
1 parent 7bb0611 commit b00c82c
Show file tree
Hide file tree
Showing 6 changed files with 113 additions and 71 deletions.
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
name: Bug Report
about: Create a report to help us identify any unintended flaws, errors, or faults
title: ''
labels: type/bug
assignees: ''

---
### Before Creating the Bug Report

- [ ] I found a bug, not just asking a question, which should be created in [GitHub Discussions](https://github.com/apache/rocketmq/discussions).
- [ ] I have searched the [GitHub Issues](https://github.com/apache/rocketmq/issues) and [GitHub Discussions](https://github.com/apache/rocketmq/discussions) of this repository and believe that this is not a duplicate.
- [ ] I have confirmed that this bug belongs to the current repository, not other repositories of RocketMQ.

### Describe the Bug

<!-- A clear and concise description of what the bug is. -->

### Steps to Reproduce

<!-- If possible, provide a recipe for reproducing the error. -->

### What Did You Expect to See?

<!-- A clear and concise description of what you expected to see. -->

### What Did You See Instead?

<!-- A clear and concise description of what you saw instead. -->

### What Version Are You Using?

<!-- (e.g., `v5.0.0`, `f3e113c`, etc) -->

### Environment

<!-- Compiler: (e.g., "Oracle JDK 11.0.17")
OS: (e.g., "Ubuntu 20.04")
Runtime (if different from JDK above): (e.g., "Oracle JRE 8u251")
OS (if different from OS compiled on): (e.g., "Windows Server 2019") -->

### Additional Context

<!-- Add any other context about the problem here. -->
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Ask Question
url: https://github.com/apache/rocketmq/discussions
about: Please go to GitHub Disccusions to ask questions
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Enhancement Request
about: Suggest an enhancement for this project
title: ''
labels: type/enhancement
assignees: ''

---
### Before Creating the Enhancement Request

<!-- Most of issues should be classified as bug or feature request. An issue should be considered as an enhancement when it proposes improvements to existing functionality or user experience, without necessarily introducing new features or fixing existing bugs. -->

- [ ] I have confirmed that this should be classified as an enhancement rather than a bug/feature.

### Summary

<!-- A clear and concise description of the enhancement you would like to see in the project. -->

### Motivation

<!-- Explain why you believe this enhancement is necessary, and how it benefits the project and community. Include any specific use cases that you have in mind. -->

### Describe the Solution You'd Like

<!-- Describe the enhancement you propose, detailing the change and implementation steps involved. If you have multiple solutions, please list them separately. -->

### Describe Alternatives You've Considered

<!-- List any alternative enhancements or implementations you have considered, and explain why they may not be as effective or appropriate. -->

### Additional Context

<!-- Add any relevant context, screenshots, prototypes, or other supplementary information to help illustrate the enhancement. -->
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Feature Request
about: Suggest an idea for this project
title: ''
labels: type/new feature
assignees: ''

---
### Is Your Feature Request Related to a Problem? Please Describe It

<!-- A clear and concise description of what the problem is. -->

### 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. -->
50 changes: 0 additions & 50 deletions .github/ISSUE_TEMPLATE/issue_template.md

This file was deleted.

29 changes: 8 additions & 21 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,15 @@
<!-- Please make sure the target branch is right. In most case, the target branch should be `develop`. -->

**Make sure set the target branch to `develop`**
### Which Issue(s) This PR Fixes

## What is the purpose of the change
<!-- Please ensure that the related issue has already been created, and [link this pull request to that issue using keywords](<https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword>) to ensure automatic closure. -->

<!--
If this PR fixes a GitHub issue, please add `fixes #<XXX>` or `closes #<XXX>`. Please refer to the documentation for more information:
https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue
-->
Fixes #issue_id

fix #<xxx> <!-- <xxx> replace with issue id -->
### Brief Description

## Brief changelog
<!-- Write a brief description for your pull request to help the maintainer understand the reasons behind your changes. -->

XX
### How Did You Test This Change?

## Verifying this change

XXXX

Follow this checklist to help us incorporate your contribution quickly and easily. Notice, `it would be helpful if you could finish the following 5 checklist(the last one is not necessary)before request the community to review your PR`.

- [x] Make sure there is a [Github issue](https://github.com/apache/rocketmq/issues) filed for the change (usually before you start working on it). Trivial changes like typos do not require a Github issue. Your pull request should address just this issue, without pulling in other changes - one PR resolves one issue.
- [x] Format the pull request title like `[ISSUE #123] Fix UnknownException when host config not exist`. Each commit in the pull request should have a meaningful subject line and body.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit-test(over 80% coverage) to verify your logic correction, more mock a little better when cross module dependency exist. If the new feature or significant change is committed, please remember to add integration-test in [test module](https://github.com/apache/rocketmq/tree/master/test).
- [x] Run `mvn -B clean apache-rat:check findbugs:findbugs checkstyle:checkstyle` to make sure basic checks pass. Run `mvn clean install -DskipITs` to make sure unit-test pass. Run `mvn clean test-compile failsafe:integration-test` to make sure integration-test pass.
- [ ] If this contribution is large, please file an [Apache Individual Contributor License Agreement](http://www.apache.org/licenses/#clas).
<!-- In order to ensure the code quality of Apache RocketMQ, we expect every pull request to have undergone thorough testing. -->

0 comments on commit b00c82c

Please sign in to comment.