Github user shroman commented on a diff in the pull request:
https://github.com/apache/incubator-rocketmq-site/pull/3#discussion_r94731141
--- Diff: _docs/06-best-practice-pull-request.md ---
@@ -4,23 +4,40 @@ permalink: /docs/pull-request/
modified: 2016-12-24T15:01:43-04:00
---
-There are several ways to setup Git for committers and contributors.
Contributors can safely setup Git any way they choose but committers should
take extra care since they can push new commits to the master at Apache and
various policies there make backing out mistakes problematic. Therefore all but
very small changes should go through a PR, even for committers. To keep the
commit history clean take note of the use of --squash below when merging into
apache/master.
+There are several ways to setup Git for committers and contributors.<br />
+Contributors can safely setup Git any way they choose but committers
should take extra care since they can push new commits to the master at Apache
and various policies there make backing out mistakes problematic. Therefore all
but very small changes should go through a PR, even for committers.<br />
+To keep the commit history clean, make use of `--squash` when merging into
`apache/master`.
{% include toc %}
# Git setup for Contributors
-This describes setup for one local repo and two remotes. It allows you to
push the code on your machine to either your Github repo or to
git-wip-us.apache.org. You will want to fork github's apache/incubator-rocketmq
to your own account on github, this will enable Pull Requests of your own.
Cloning this fork locally will set up "origin" to point to your remote fork on
github as the default remote. So if you perform "git push origin master" it
will go to github.
+First of all, fork githubâs `apache/incubator-rocketmq` to your own
account on github and clone it as follows,
-To attach to the apache git repo do the following:
+ git clone https://github.com/<your_github_name>/incubator-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 sometimes).
--- End diff --
It's a good idea, I was thinking about it too, but decided to skip it
because I suppose everyone knows it. But yes, let's add it.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
