From 510ae36da83cec7fa32a9cee7d5cc84092f416da Mon Sep 17 00:00:00 2001 From: yukon Date: Tue, 20 Mar 2018 21:56:44 +0800 Subject: [PATCH] Add pr and issue template --- .github/ISSUE_TEMPLATE.md | 31 +++++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 22 ++++++++++++++++++++++ _docs/02-motivation.md | 3 +++ 3 files changed, 56 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000000..2cd7924a65 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -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, +- ... \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..eb8cb83a63 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,22 @@ +Please do not create a Pull Request without creating an issue first. + +## 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: + +- [x] Make sure there is a Github issue 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. +- [ ] 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. +- [ ] Write a pull request description that is detailed enough to understand what the pull request does, how, and why. +- [ ] Write necessary unit-test 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). +- [ ] 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). diff --git a/_docs/02-motivation.md b/_docs/02-motivation.md index da0070184f..db6cd5a9e1 100644 --- a/_docs/02-motivation.md +++ b/_docs/02-motivation.md @@ -29,6 +29,9 @@ The following table demonstrates the comparison between RocketMQ, ActiveMQ and K # RocketMQ vs. ActiveMQ vs. Kafka +Please note this documentation is written by the RocketMQ team. Although the ideal is a disinterested comparison of technology and features, the authors’ expertise and biases obviously favor RocketMQ. + +The table below is a handy quick reference for spotting the differences among RocketMQ and its most popular alternatives at a glance. | Messaging Product|Client SDK| Protocol and Specification | Ordered Message | Scheduled Message | Batched Message |BroadCast Message| Message Filter|Server Triggered Redelivery|Message Storage|Message Retroactive|Message Priority|High Availability and Failover|Message Track|Configuration|Management and Operation Tools| | -------|--------|--------|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|