You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rocketmq.apache.org by vo...@apache.org on 2018/08/07 10:08:05 UTC
[rocketmq-site] branch master updated: Update doc
This is an automated email from the ASF dual-hosted git repository.
vongosling pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/rocketmq-site.git
The following commit(s) were added to refs/heads/master by this push:
new 90d6eae Update doc
90d6eae is described below
commit 90d6eae0c84b10d57fb7c598199c56267e65ca5d
Author: vongosling <vo...@alibaba-inc.com>
AuthorDate: Tue Aug 7 18:07:55 2018 +0800
Update doc
---
_docs/01-quick-start-guide.md | 8 ++---
_docs/06-best-practice-pull-request.md | 55 ++++------------------------------
_docs/24-how-to-contribute.md | 12 ++++----
3 files changed, 16 insertions(+), 59 deletions(-)
diff --git a/_docs/01-quick-start-guide.md b/_docs/01-quick-start-guide.md
index 31e656a..d6271a1 100644
--- a/_docs/01-quick-start-guide.md
+++ b/_docs/01-quick-start-guide.md
@@ -20,13 +20,13 @@ and receive messages.
# Download & Build from Release
-Click [here](https://www.apache.org/dyn/closer.cgi?path=rocketmq/4.2.0/rocketmq-all-4.2.0-source-release.zip) to download the 4.2.0 source release. Also you could download a binary release from [here](http://rocketmq.apache.org/release_notes/release-notes-4.2.0/).
+Click [here](https://www.apache.org/dyn/closer.cgi?path=rocketmq/4.3.0/rocketmq-all-4.3.0-source-release.zip) to download the 4.3.0 source release. Also you could download a binary release from [here](http://rocketmq.apache.org/release_notes/release-notes-4.3.0/).
-Now execute the following commands to unpack 4.2.0 source release and build the binary artifact.
+Now execute the following commands to unpack 4.3.0 source release and build the binary artifact.
```shell
- > unzip rocketmq-all-4.2.0-source-release.zip
- > cd rocketmq-all-4.2.0/
+ > unzip rocketmq-all-4.3.0-source-release.zip
+ > cd rocketmq-all-4.3.0/
> mvn -Prelease-all -DskipTests clean install -U
> cd distribution/target/apache-rocketmq
```
diff --git a/_docs/06-best-practice-pull-request.md b/_docs/06-best-practice-pull-request.md
index 9600d39..1d4b4ef 100644
--- a/_docs/06-best-practice-pull-request.md
+++ b/_docs/06-best-practice-pull-request.md
@@ -19,35 +19,12 @@ Now you can create your pull requests.
You will need to update a local master sometimes (to merge to your development branches).
For this, you have to add remote for RocketMQ mirror as follows,
- git remote add upstream https://github.com/apache/rocketmq.git
+ git remote add apache https://github.com/apache/rocketmq.git
and update your local master via `git fetch` followed by `git rebase`, for instance:
- git fetch upstream master
- git rebase upstream/master
-# Git setup for Committers
-In addition to contributors' configurations, committers will have to attach the apache git repo:
-
- git remote add apache https://git-wip-us.apache.org/repos/asf/rocketmq.git
-
-To check your remote setup, issue
-
- git remote -v
-
-You should see something like this:
-
- origin https://github.com/<your_github_name>/rocketmq.git (fetch)
- origin https://github.com/<your_github_name>/rocketmq.git (push)
- upstream https://github.com/apache/rocketmq.git (fetch)
- upstream https://github.com/apache/rocketmq.git (push)
- apache https://git-wip-us.apache.org/repos/asf/rocketmq.git (fetch)
- apache https://git-wip-us.apache.org/repos/asf/rocketmq.git (push)
-
-Now if you want to experiment with a branch everything, by default, points to your github account because 'origin' is default. You can work as normal using only github until you are ready to merge with the apache remote. Some conventions will integrate with Apache Github issue ticket numbers.
-
- git checkout -b ROCKETMQ-xxxx #xxxx typically is a Github issue ticket number
-
-_To ensure the code quality of the master branch, all but minor changes should go through pull requests reviewed by peer committers._
+ git fetch apache master
+ git rebase apache/master
# Do some work on the branch
@@ -85,16 +62,7 @@ You pull request will be reviewed and commented by committers, and issues can be
# 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 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).
-```
+Each pull request should follow the [checklist](https://github.com/apache/rocketmq/blob/master/.github/PULL_REQUEST_TEMPLATE.md) to help us incorporate your contribution quickly and easily.
Remember use `- [x]` mark an item finished in the check list and there is a [demo pull request](https://github.com/apache/rocketmq/pull/152) can be your reference.
@@ -120,7 +88,7 @@ If all requirements are met, you can commit the squashed request using:
git commit --author="contributor_name <contributor_email>" -a -m "ROCKETMQ-XXXX description closes apache/rocketmq#ZZ"
ROCKETMQ-XXXX is all capitalized and ZZ is the pull request number on apache/rocketmq repository. Including "closes apache/rocketmq#ZZ" will close the PR automatically. More information can be found here [GitHub PR closing docs.](https://help.github.com/articles/closing-issues-via-commit-messages/).
-Next, push to git-wip-us.apache.org:
+Next, push to apache:
git push apache master
@@ -137,18 +105,7 @@ When we want to reject a PR (close without committing), we can just issue an emp
git commit --allow-empty -m "ROCKETMQ-XXXX closes apache/rocketmq#ZZ *Won't fix*"
git push apache master
-that should close PR ZZ on github mirror without merging and any code modifications in the master repository.more detail please refer to RocketMQ PR https://github.com/apache/rocketmq/pull/15
-
-# Best Practises
-
-## Avoiding accidentally committing private branches to the ASF repo
-
-It's dangerous —especially when using IDEs— to accidentally commit changes to the ASF repo, be directed to the trunk, branch-2, other standard branch on which you are developing, or to a private branch you had intended to keep on github (or a private repo).
-
-Committers can avoid this by setting the directory in which they develop code to read only access to the ASF repository on github. A separate directory should also be set up with write access to the ASF repository as well as read access to your other repositories. Merging operations and push backs to the ASF repo are done from this directory —so it will be immune to all local changes.
-
-If you accidentally committed a patch to an ASF branch, do not attempt to roll back the branch and force out a new update. Simply commit and push out a new patch revoking the change.
+that should close PR ZZ on github mirror without merging and any code modifications in the master repository.
-If you do accidentally committed a branch to the ASF repo, the infrastructure team can delete it —but they cannot stop it propagating to github and potentially being visible. Please avoid this.
diff --git a/_docs/24-how-to-contribute.md b/_docs/24-how-to-contribute.md
index 3c1da24..25732f0 100644
--- a/_docs/24-how-to-contribute.md
+++ b/_docs/24-how-to-contribute.md
@@ -1,5 +1,5 @@
---
-title: "How To Contribute"
+title: "How to Contribute"
permalink: /docs/how-to-contribute/
modified: 2017-8-23T15:01:43-04:00
---
@@ -12,11 +12,11 @@ Apache RocketMQ is developed by an open and friendly community. Everybody is cor
The Apache RocketMQ community is eager to help and to answer your questions. We have a [user mailing list](/about/contact/) and [apache-rocketmq](https://stackoverflow.com/questions/tagged/rocketmq) tag on Stack Overflow.
## File a bug report
-Please let us know if you experienced a problem with RocketMQ and file a bug report. Open [JIRA Issue](https://issues.apache.org/jira/projects/ROCKETMQ) and click on the blue Create button at the top. Please give detailed information about the problem you encountered and, if possible, add a description that helps to reproduce the problem. Thank you very much.
+Please let us know if you experienced a problem with RocketMQ and file a bug report. Open [Github Issue](https://github.com/apache/rocketmq/issues) and click on the New issue.
## Propose an improvement or a new feature
-Our community is constantly looking for feedback to improve Apache RocketMQ. If you have an idea how to improve RocketMQ or have a new feature in mind that would be beneficial for RocketMQ users, please open an issue in [RocketMQ’s JIRA](https://issues.apache.org/jira/projects/ROCKETMQ). The improvement or new feature should be described in appropriate detail and include the scope and its requirements if possible. Detailed information is important for a few reasons:
+Our community is constantly looking for feedback to improve Apache RocketMQ. If you have an idea how to improve RocketMQ or have a new feature in mind that would be beneficial for RocketMQ users, please open an issue in [RocketMQ’s ISSUE](https://github.com/apache/rocketmq/issues). The improvement or new feature should be described in appropriate detail and include the scope and its requirements if possible. Detailed information is important for a few reasons:
* It ensures your requirements are met when the improvement or feature is implemented.
* It helps to estimate the effort and to design a solution that addresses your needs.
@@ -53,13 +53,13 @@ Please do also read the Submit a [Contributor License Agreement Section](http://
Looking for an issue to work on?
-We maintain a list of all known bugs, proposed improvements and suggested features in [RocketMQ’s JIRA](https://issues.apache.org/jira/projects/ROCKETMQ).
+We maintain a list of all known bugs, proposed improvements and suggested features in [Github issue](https://github.com/apache/rocketmq/issues).
## Contribute documentation
Good documentation is crucial for any kind of software. The Apache RocketMQ community aims to provide concise, precise, and complete documentation and welcomes any contribution to improve Apache RocketMQ’s documentation.
-* Please report missing, incorrect, or out-dated documentation as a [JIRA ISSUE](https://issues.apache.org/jira/projects/ROCKETMQ).
+* Please report missing, incorrect, or out-dated documentation as a [Github issue](https://github.com/apache/rocketmq/issues).
* RocketMQ’s documentation is written in Markdown and located in the docs folder in RocketMQ’s [site source code repository](https://github.com/apache/rocketmq-site). See the Contribute [documentation guidelines](/docs/code-guidelines/) for detailed instructions for how to update and improve the documentation and to contribute your changes.
## Improve the website
@@ -72,7 +72,7 @@ The Apache RocketMQ website presents Apache RocketMQ and its community. It serve
We welcome any contribution to improve our website.
-Please open a [JIRA issue](https://issues.apache.org/jira/projects/ROCKETMQ) if you think our website could be improved.
+Please open a [Github issue](https://github.com/apache/rocketmq-site/issues) if you think our website could be improved.
Please follow the Improve the [website guidelines](https://github.com/apache/rocketmq-site) if you would like to update and improve the website.
## More ways to contribute…