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 2021/08/12 08:15:53 UTC
[rocketmq-site] branch master updated: Improve the "How to
contribute" docs (#82)
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 3852a0b Improve the "How to contribute" docs (#82)
3852a0b is described below
commit 3852a0b282e31aa129146e4379b02bfb70994182
Author: Martin Grigorov <ma...@users.noreply.github.com>
AuthorDate: Thu Aug 12 11:15:49 2021 +0300
Improve the "How to contribute" docs (#82)
* improve wording
* fix typos
* add links where appropriate
* mention that Pull Requests are automatically tested at Travis CI
Co-authored-by: von gosling <vo...@apache.org>
---
README.md | 6 +++---
_docs/06-best-practice-pull-request.md | 7 ++++---
_docs/24-how-to-contribute.md | 6 +++---
3 files changed, 10 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 2913cc6..cf193a8 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@ This website is based on Jekyll and a Jekyll theme named Minimal Mistakes.
## Install & Run
1. gem install jekyll bundler
2. git clone this repo
-3. cd rocketmq-sites
+3. cd rocketmq-site
4. bundle install
5. bundle exec jekyll serve
@@ -26,12 +26,12 @@ This website is based on Jekyll and a Jekyll theme named Minimal Mistakes.
## Questions
### How to post articles to **Documentation**?
-New a .md file in rocketmq-sites/_docs/, Jekyll will finish the rest of the work.
+Create a .md file in rocketmq-sites/_docs/, Jekyll will finish the rest of the work.
Please refer to **01-quick-start-guide.md** for more details.
### How to post articles to **Blog**?
-New a .md file in rocketmq-sites/_posts/, Jekyll will finish the rest of the work.
+Create a .md file in rocketmq-sites/_posts/, Jekyll will finish the rest of the work.
Please refer to **2016-12-23-mastering-component-compatible-dependency.md** for more details.
diff --git a/_docs/06-best-practice-pull-request.md b/_docs/06-best-practice-pull-request.md
index 104e2d2..28b45a4 100644
--- a/_docs/06-best-practice-pull-request.md
+++ b/_docs/06-best-practice-pull-request.md
@@ -9,7 +9,7 @@ This page guides you through Git setup and contribution process.
{% include toc %}
# Git setup for Contributors
-First of all, fork github’s `apache/rocketmq` to your own account on github and clone it as follows,
+First of all, fork github’s [apache/rocketmq](https://github.com/apache/rocketmq) to your own account on github and clone it as follows,
git clone https://github.com/<your_github_name>/rocketmq.git
@@ -28,6 +28,7 @@ and update your local master via `git fetch` followed by `git rebase`, for insta
# Do some work on the branch
+ git checkout -b ROCKETMQ-xxxx # create a branch
git commit -a -m "doing some work"
git push origin ROCKETMQ-xxxx # notice pushing to **origin** not **apache**
@@ -42,7 +43,7 @@ Push your branch to Github:
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/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 issue comments.
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 Github issue and the mailing list.
@@ -52,7 +53,7 @@ Push your branch to Github:
Before you create a pull request, make sure
1. A corresponding [Github issue](https://github.com/apache/rocketmq/issues) is created and has a clear problem description.
2. Make sure you follow [Coding Guidelines](/docs/code-guidelines/).
-3. You have unit tests for everything you are about to commit.
+3. You have unit tests for everything you are about to commit. All pull requests are automatically tested at [Travis CI](https://travis-ci.org/github/apache/rocketmq) on AMD64 and ARM64 CPU architectures.
For information about creating pull requests, please check [GitHub PR docs](https://help.github.com/articles/creating-a-pull-request/).
diff --git a/_docs/24-how-to-contribute.md b/_docs/24-how-to-contribute.md
index 25732f0..37fdfc2 100644
--- a/_docs/24-how-to-contribute.md
+++ b/_docs/24-how-to-contribute.md
@@ -29,8 +29,8 @@ We recommend to first reach consensus with the community on whether a new featur
## Help others and join the discussions
Most communication in the Apache RocketMQ community happens on two mailing lists:
-* The user mailing lists users@rocketmq.apache.org is the place where users of Apache RocketMQ ask questions and seek for help or advice. Joining the user list and helping other users is a very good way to contribute to RocketMQ’s community. Furthermore, there is the [apache-rocketmq](https://stackoverflow.com/questions/tagged/rocketmq) tag on Stack Overflow if you’d like to help RocketMQ users (and harvest some points) there.
-* The development mailing list dev@rocketmq.apache.org is the place where RocketMQ developers exchange ideas and discuss new features, upcoming releases, and the development process in general. If you are interested in contributing code to RocketMQ, you should join this mailing list.
+* The [user mailing lists](mailto:users@rocketmq.apache.org) is the place where users of Apache RocketMQ ask questions and seek for help or advice. Joining the user list and helping other users is a very good way to contribute to RocketMQ’s community. Furthermore, there is the [rocketmq](https://stackoverflow.com/questions/tagged/rocketmq) tag on Stack Overflow if you’d like to help RocketMQ users (and harvest some points) there.
+* The [development mailing list](mailto:dev@rocketmq.apache.org) is the place where RocketMQ developers exchange ideas and discuss new features, upcoming releases, and the development process in general. If you are interested in contributing code to RocketMQ, you should join this mailing list.
You are very welcome to subscribe to both [mailing lists](/about/contact/).
@@ -86,7 +86,7 @@ There are many more ways to contribute to the RocketMQ community. For example yo
## How to become a committer
-Committers are community members that have write access to the project’s repositories, i.e., they can modify the code, documentation, and website by themselves and also accept other contributions.
+Committers are community members that have write access to the project’s repositories, i.e. they can modify the code, documentation, and website by themselves and also accept other contributions.
There is no strict protocol for becoming a committer. Candidates for new committers are typically people that are active contributors and community members.