This is an automated email from the ASF dual-hosted git repository.
aaronai pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/rocketmq.git
The following commit(s) were added to refs/heads/develop by this push:
new b00c82cac Rewrite the issue/pull request template of RocketMQ (#6645)
b00c82cac is described below
commit b00c82caccea8d8a23614c1854885d0a187e159e
Author: Aaron Ai <[email protected]>
AuthorDate: Wed Apr 26 13:37:20 2023 +0800
Rewrite the issue/pull request template of RocketMQ (#6645)
---
.github/ISSUE_TEMPLATE/bug_report.md | 44 +++++++++++++++++++++++
.github/ISSUE_TEMPLATE/config.yml | 5 +++
.github/ISSUE_TEMPLATE/enhancement_request.md | 33 ++++++++++++++++++
.github/ISSUE_TEMPLATE/feature_request.md | 23 ++++++++++++
.github/ISSUE_TEMPLATE/issue_template.md | 50 ---------------------------
.github/PULL_REQUEST_TEMPLATE.md | 29 +++++-----------
6 files changed, 113 insertions(+), 71 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md
b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 000000000..1264226c1
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -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. -->
diff --git a/.github/ISSUE_TEMPLATE/config.yml
b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..26e931535
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -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
diff --git a/.github/ISSUE_TEMPLATE/enhancement_request.md
b/.github/ISSUE_TEMPLATE/enhancement_request.md
new file mode 100644
index 000000000..4603de1a2
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/enhancement_request.md
@@ -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. -->
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md
b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 000000000..ed51a0b8b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -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. -->
diff --git a/.github/ISSUE_TEMPLATE/issue_template.md
b/.github/ISSUE_TEMPLATE/issue_template.md
deleted file mode 100644
index 9357bb222..000000000
--- a/.github/ISSUE_TEMPLATE/issue_template.md
+++ /dev/null
@@ -1,50 +0,0 @@
----
-name: ISSUE_TEMPLATE
-about: Describe this issue template's purpose here.
-
----
-
-The issue tracker is used for bug reporting purposes **ONLY** whereas feature
request needs to follow the [RIP
process](https://github.com/apache/rocketmq/wiki/RocketMQ-Improvement-Proposal).
To avoid unnecessary duplication, please check whether there is a previous
issue before filing a new one.
-
-It is recommended to start a discussion thread in the [mailing
lists](http://rocketmq.apache.org/about/contact/) or [github
discussions](https://github.com/apache/rocketmq/discussions) in cases of
discussing your deployment plan, API clarification, and other non-bug-reporting
issues.
-We welcome any friendly suggestions, bug fixes, collaboration, and other
improvements.
-
-Please ensure that your bug report is clear and self-contained. Otherwise, it
would take additional rounds of communication, thus more time, to understand
the problem itself.
-
-Generally, fixing an issue goes through the following steps:
-1. Understand the issue reported;
-1. Reproduce the unexpected behavior locally;
-1. Perform root cause analysis to identify the underlying problem;
-1. Create test cases to cover the identified problem;
-1. Work out a solution to rectify the behavior and make the newly created test
cases pass;
-1. Make a pull request and go through peer review;
-
-As a result, it would be very helpful yet challenging if you could provide an
isolated project reproducing your reported issue. Anyway, please ensure your
issue report is informative enough for the community to pick up. At a minimum,
include the following hints:
-
-**BUG REPORT**
-
-1. Please describe the issue you observed:
-
-- What did you do (The steps to reproduce)?
-
-- What is expected to see?
-
-- What did you see instead?
-
-2. Please tell us about your environment:
-
-3. Other information (e.g. detailed explanation, logs, related issues,
suggestions on how to fix, etc):
-
-**FEATURE REQUEST**
-
-1. Please describe the feature you are requesting.
-
-2. Provide any additional detail on your proposed use case for this feature.
-
-3. Indicate the importance of this issue to you (blocker, must-have,
should-have, nice-to-have). Are you currently using any workarounds to address
this issue?
-
-4. If there are some sub-tasks involved, use -[] for each sub-task and create
a corresponding issue to map to the sub-task:
-
-- [sub-task1-issue-number](example_sub_issue1_link_here): sub-task1
description here,
-- [sub-task2-issue-number](example_sub_issue2_link_here): sub-task2
description here,
-- ...
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 550a6fd5b..96bffa55a 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -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. -->
