mirror of
https://github.com/apache/rocketmq-dashboard.git
synced 2025-09-09 19:25:33 +08:00
Add issue and pr template
This commit is contained in:
31
.github/ISSUE_TEMPLATE.md
vendored
Normal file
31
.github/ISSUE_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,31 @@
|
||||
The issue tracker is **ONLY** used for bug report and feature request.
|
||||
|
||||
Any question or RocketMQ proposal please use our [mailing lists](http://rocketmq.apache.org/about/contact/).
|
||||
|
||||
**BUG REPORT**
|
||||
|
||||
1. Please describe the issue you observed:
|
||||
|
||||
- What did you do (The steps to reproduce)?
|
||||
|
||||
- What did you expect 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 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.
|
||||
|
||||
2. 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 using -[] for each subtask 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,
|
||||
- ...
|
20
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
20
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
## What is the purpose of the change
|
||||
|
||||
XXXXX
|
||||
|
||||
## Brief changelog
|
||||
|
||||
XX
|
||||
|
||||
## 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).
|
Reference in New Issue
Block a user