Skip to content

Commit

Permalink
[ROCKETMQ-302] TLP clean up, remove incubating related info and polis…
Browse files Browse the repository at this point in the history
…h the release manual
  • Loading branch information
zhouxinyu committed Oct 9, 2017
1 parent b68ac99 commit b516640
Show file tree
Hide file tree
Showing 24 changed files with 112 additions and 188 deletions.
1 change: 0 additions & 1 deletion DISCLAIMER

This file was deleted.

2 changes: 1 addition & 1 deletion NOTICE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Apache RocketMQ (incubating)
Apache RocketMQ
Copyright 2016-2017 The Apache Software Foundation

This product includes software developed at
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Apache RocketMQ (incubating) website
# Apache RocketMQ website

This is the website for [Apache RocketMQ]( http://rocketmq.apache.org/) (incubating).
This is the website for [Apache RocketMQ]( http://rocketmq.apache.org/).

## About
This website is based on Jekyll and a Jekyll theme named Minimal Mistakes.
Expand Down
2 changes: 1 addition & 1 deletion _about/01-team.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ excerpt: "Project team."
modified: 2016-12-28T19:55:43-04:00
---

The RocketMQ team is comprised of Members and Contributors. Members have direct access to the source of RocketMQ project and actively evolve the code-base. Contributors improve the project through submission of patches and suggestions to the Members. The number of Contributors to the project is unbounded. All contributions to RocketMQ are greatly appreciated, whether for trivial cleanups, big new features or other material rewards. More details see [here](https://github.com/apache/incubator-rocketmq/blob/master/CONTRIBUTING.md).
The RocketMQ team is comprised of Members and Contributors. Members have direct access to the source of RocketMQ project and actively evolve the code-base. Contributors improve the project through submission of patches and suggestions to the Members. The number of Contributors to the project is unbounded. All contributions to RocketMQ are greatly appreciated, whether for trivial cleanups, big new features or other material rewards. More details see [here](https://github.com/apache/rocketmq/blob/master/CONTRIBUTING.md).


### Members
Expand Down
8 changes: 4 additions & 4 deletions _about/02-contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ These are the mailing lists that have been established for RocketMQ. For each li

|Name|Description|Subscribe|Unsubscribe|Archive|
|:---|:---|:---|:---|:---|
|Users|User support and questions mailing list| [Subscribe](mailto:users-subscribe@rocketmq.incubator.apache.org)|[Unsubscribe](mailto:users-unsubscribe@rocketmq.incubator.apache.org)|[mail-archives.apache.org](http://mail-archives.apache.org/mod_mbox/incubator-rocketmq-users/)|
|Issues|Mirror of all JIRA activity| [Subscribe](mailto:issues-subscribe@rocketmq.incubator.apache.org)|[Unsubscribe](mailto:issues-unsubscribe@rocketmq.incubator.apache.org)|[mail-archives.apache.org](http://mail-archives.apache.org/mod_mbox/incubator-rocketmq-issues/)|
|Development|Development related discussions|[Subscribe](mailto:dev-subscribe@rocketmq.incubator.apache.org)|[Unsubscribe](mailto:dev-unsubscribe@rocketmq.incubator.apache.org)|[mail-archives.apache.org](http://mail-archives.apache.org/mod_mbox/incubator-rocketmq-dev//)|
|Commits|All commits to repositories|[Subscribe](mailto:commits-subscribe@rocketmq.incubator.apache.org)|[Unsubscribe](mailto:commits-unsubscribe@rocketmq.incubator.apache.org)|[mail-archives.apache.org](http://mail-archives.apache.org/mod_mbox/incubator-rocketmq-commits/)|
|Users|User support and questions mailing list| [Subscribe](mailto:[email protected])|[Unsubscribe](mailto:[email protected])|[Mail Archives](https://lists.apache.org/list.html?users@rocketmq.apache.org)|
|Issues|Mirror of all JIRA activity| [Subscribe](mailto:[email protected])|[Unsubscribe](mailto:[email protected])|[Mail Archives](https://lists.apache.org/list.html?issues@rocketmq.apache.org)|
|Development|Development related discussions|[Subscribe](mailto:[email protected])|[Unsubscribe](mailto:[email protected])|[Mail Archives](https://lists.apache.org/list.html?dev@rocketmq.apache.org)|
|Commits|All commits to repositories|[Subscribe](mailto:[email protected])|[Unsubscribe](mailto:[email protected])|[Mail Archives](https://lists.apache.org/list.html?commits@rocketmq.apache.org)|

## Security Issues Tracking

Expand Down
8 changes: 4 additions & 4 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ name : "Apache RocketMQ"
description : "The homepage of RocketMQ."
url : # the base hostname & protocol for your site e.g. "https://mmistakes.github.io"
baseurl : # the subpath of your site, e.g. "/blog"
repository : "apache/incubator-rocketmq"
repository : "apache/rocketmq"
comment-repository : "zhouxinyu/rocketmq-comments"
teaser : # path of fallback teaser image, e.g. "/assets/images/500x300.png"
destination : content
Expand Down Expand Up @@ -84,15 +84,15 @@ author:
avatar : "/assets/images/rmq-logo.png"
bio : "An open source distributed messaging and streaming data platform."
location : "Hangzhou, China"
email : "dev@rocketmq.incubator.apache.org"
uri : "http://incubator.staging.apache.org/projects/rocketmq.html"
email : "[email protected]"
uri : "http://rocketmq.apache.org"
bitbucket :
codepen :
dribbble :
flickr :
facebook :
foursquare :
github : "apache/incubator-rocketmq"
github : "apache/rocketmq"
google_plus :
keybase :
instagram :
Expand Down
4 changes: 2 additions & 2 deletions _docs/01-quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ and receive messages.
# Clone & Build

```shell
> git clone -b develop https://github.com/apache/incubator-rocketmq.git
> cd incubator-rocketmq
> git clone -b develop https://github.com/apache/rocketmq.git
> cd rocketmq
> mvn -Prelease-all -DskipTests clean install -U
> cd distribution/target/apache-rocketmq
```
Expand Down
2 changes: 1 addition & 1 deletion _docs/04-cli-admin-tool.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Make sure you have walked through [Quick Start](/docs/quick-start/) and [Core Co

The admin tool is shipped along with RocketMQ. Whether you download a pre-built binary version or build from source by yourself, you have the tool with the package.

If you want to look at the source code, please refer to [rocketmq-tools module](https://github.com/apache/incubator-rocketmq/tree/master/tools)
If you want to look at the source code, please refer to [rocketmq-tools module](https://github.com/apache/rocketmq/tree/master/tools)

# How to use

Expand Down
42 changes: 21 additions & 21 deletions _docs/06-best-practice-pull-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ This page guides you through Git setup and contribution process.
{% include toc %}

# Git setup for Contributors
First of all, fork github’s `apache/incubator-rocketmq` to your own account on github and clone it as follows,
First of all, fork github’s `apache/rocketmq` to your own account on github and clone it as follows,

git clone https://github.com/<your_github_name>/incubator-rocketmq.git
git clone https://github.com/<your_github_name>/rocketmq.git

Cloning this locally will set up `origin` to point to your remote fork on github as the default remote.
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/incubator-rocketmq.git
git remote add upstream https://github.com/apache/rocketmq.git

and update your local master via `git fetch` followed by `git rebase`, for instance:
git fetch upstream master
Expand All @@ -28,20 +28,20 @@ and update your local master via `git fetch` followed by `git rebase`, for insta
# 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/incubator-rocketmq.git
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>/incubator-rocketmq.git (fetch)
origin https://github.com/<your_github_name>/incubator-rocketmq.git (push)
upstream https://github.com/apache/incubator-rocketmq.git (fetch)
upstream https://github.com/apache/incubator-rocketmq.git (push)
apache https://git-wip-us.apache.org/repos/asf/incubator-rocketmq.git (fetch)
apache https://git-wip-us.apache.org/repos/asf/incubator-rocketmq.git (push)
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 JIRA ticket numbers.

Expand All @@ -63,11 +63,11 @@ Push your branch to Github:
git checkout ROCKETMQ-xxxx
git push origin ROCKETMQ-xxxx

1. Go to your ROCKETMQ-xxxx branch on Github. Since you forked it from Github's apache/incubator-rocketmq. By default all PR will go to apache/master.
1. Go to your ROCKETMQ-xxxx branch on Github. Since you forked it from Github's apache/rocketmq. By default all PR will go to apache/master.

2. Click the green "Compare, review, and create pull request" button. You can edit the to and from for the PR if it isn't correct. The "base fork" should be apache/incubator-rocketmq unless you are collaborating with one of the committers on the list. The "base" will be master. Don't submit a PR to any other branches unless permitted by branch owner. The "head fork" will be your forked repo and the "compare" will be your ROCKETMQ-xxxx branch.
2. Click the green "Compare, review, and create pull request" button. You can edit the to and from for the PR if it isn't correct. The "base fork" should be apache/rocketmq unless you are collaborating with one of the committers on the list. The "base" will be master. Don't submit a PR to any other branches unless permitted by branch owner. The "head fork" will be your forked repo and the "compare" will be your ROCKETMQ-xxxx branch.
3. Click the "Create pull request" button and name the request "ROCKETMQ-xxxx" all caps. This will connect the comments of the PR to the mailing list and JIRA comments.
4. From now on the PR lives on github's apache/incubator-rocketmq. You can use the commenting UI there.
4. From now on the PR lives on github's apache/rocketmq. You can use the commenting UI there.
5. If you are looking for a review or wanting to share with someone else please write a note in the comments and don't worry about automated merging of your PR -- you will have to do that later. The PR is tied to your branch so you can respond to comments, make fixes, and commit them from your local repo. They will appear on the PR page and be mirrored to JIRA and the mailing list.
6. When you are satisfied and want to push it to Apache's remote repo, you can merge this PR.

Expand All @@ -79,7 +79,7 @@ Before you create a pull request, make sure

For information about creating pull requests, please check [GitHub PR docs](https://help.github.com/articles/creating-a-pull-request/).

Pull requests are made to `apache/incubator-rocketmq` repository on Github.
Pull requests are made to `apache/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.

Expand All @@ -91,21 +91,21 @@ Each pull request should follow this checklist to help us incorporate your contr
- [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).
- [ ] 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).

```

Remember use `- [x]` mark an 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.
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.

# 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:

git checkout master # switch to local master branch
git pull apache master # fast-forward to current remote HEAD
git pull --squash https://github.com/cuser/incubator-rocketmq.git ROCKETMQ-xxxx # merge to master
git pull --squash https://github.com/cuser/rocketmq.git ROCKETMQ-xxxx # merge to master

`--squash` ensures all PR history is squashed into single commit, and allows committer to use his/her own message. Please refer to git help for merge or pull for more information about `--squash` option. In this example we assume that the contributor's Github handle is "cuser" and the PR branch name is "ROCKETMQ-xxxx". Next, resolve all conflicts, or ask a contributor to rebase on top of master, if PR went out of sync.

Expand All @@ -118,9 +118,9 @@ If you are ready to merge your own (committer's) PR you only need to merge (not
Please run regular patch checks, build with tests enabled, and change CHANGELOG whenever needed.
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/incubator-rocketmq#ZZ"
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/incubator-rocketmq repository. Including "closes apache/incubator-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/).
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:

git push apache master
Expand All @@ -135,10 +135,10 @@ Note on squashing: Since squash discards remote branch history, repeated PRs fro
# Closing a PR without committing (for committers)
When we want to reject a PR (close without committing), we can just issue an empty commit on master's HEAD without merging the PR:

git commit --allow-empty -m "ROCKETMQ-XXXX closes apache/incubator-rocketmq#ZZ *Won't fix*"
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/incubator-rocketmq/pull/15
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


# Apache/github integration features
Expand Down
Loading

0 comments on commit b516640

Please sign in to comment.