You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rocketmq.apache.org by yu...@apache.org on 2017/09/07 06:21:40 UTC

incubator-rocketmq-site git commit: Add a checklist when create a pull request

Repository: incubator-rocketmq-site
Updated Branches:
  refs/heads/master 9dce04a64 -> e194d2beb


Add a checklist when create a pull request


Project: http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/commit/e194d2be
Tree: http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/tree/e194d2be
Diff: http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/diff/e194d2be

Branch: refs/heads/master
Commit: e194d2bebc2458671c7f827b10e177bcfd1b67c7
Parents: 9dce04a
Author: yukon <yu...@apache.org>
Authored: Thu Sep 7 14:21:20 2017 +0800
Committer: yukon <yu...@apache.org>
Committed: Thu Sep 7 14:21:20 2017 +0800

----------------------------------------------------------------------
 _docs/06-best-practice-pull-request.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-rocketmq-site/blob/e194d2be/_docs/06-best-practice-pull-request.md
----------------------------------------------------------------------
diff --git a/_docs/06-best-practice-pull-request.md b/_docs/06-best-practice-pull-request.md
index 321ba1a..084cbf8 100644
--- a/_docs/06-best-practice-pull-request.md
+++ b/_docs/06-best-practice-pull-request.md
@@ -83,6 +83,22 @@ Pull requests are made to `apache/incubator-rocketmq` repository on Github.
 In the Github UI you should pick the master branch as target of the PR. <br />
 You pull request will be reviewed and commented by committers, and issues can be discussed. When all reviewers are positive on the pull request, it will be merged.
 
+# Check List for a PR
+
+Each pull request should follow this checklist to help us incorporate your contribution quickly and easily:
+
+```markdown
+- [x] Make sure there is a [JIRA issue](https://issues.apache.org/jira/projects/ROCKETMQ/issues/) filed for the change (usually before you start working on it). Trivial changes like typos do not require a JIRA 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 `[ROCKETMQ-XXX] 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/incubator-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).
+
+```
+
+Remember use `- [x]` mark a item finished in the check list and there is a [demo pull request](https://github.com/apache/incubator-rocketmq/pull/152) can be your reference. 
+
 # Merging a PR (yours or contributors)
 Start with reading [GitHub PR merging locally](https://help.github.com/articles/checking-out-pull-requests-locally/). Remember that pull requests are equivalent to a remote github branch with potentially a multitude of commits. In this case it is recommended to squash remote commit history to have one commit per issue, rather than merging in a multitude of contributor's commits. In order to do that, as well as to close the PR at the same time, it is recommended to use squash commits.
 Merging pull requests are equivalent to a "pull" of a contributor's branch: