Skip to content

Commit a492592

Browse files
ferrirWwangfan
and
wangfan
authored
[Docs] Add squash guide and apache contributors guide link (#4221)
Co-authored-by: wangfan <[email protected]>
1 parent b6e65a8 commit a492592

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

CONTRIBUTING.md

+18-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ We want to have high quality, well documented codes for each programming languag
55

66
Nor is code the only way to contribute to the project. We strongly value documentation, integration with other project, and gladly accept improvements for these aspects.
77

8+
Recommend reading:
9+
* [Contributors Tech Guide](http://www.apache.org/dev/contributors)
10+
* [Get involved!](http://www.apache.org/foundation/getinvolved.html)
11+
812
## Contributing code
913

1014
To submit a change for inclusion, please do the following:
@@ -13,6 +17,19 @@ To submit a change for inclusion, please do the following:
1317
#### If you are introducing a completely new feature or API it is a good idea to start a [RIP](https://github.com/apache/rocketmq/wiki/RocketMQ-Improvement-Proposal) and get consensus on the basic design first.
1418
#### It is our job to follow up on patches in a timely fashion. Nag us if we aren't doing our job (sometimes we drop things).
1519

20+
### Squash commits
21+
22+
If your have a pull request on GitHub, and updated more than once, it's better to squash all commits.
23+
24+
1. Identify how many commits you made since you began: ``git log``.
25+
2. Squash these commits by N: ``git rebase -i HEAD~N`` .
26+
3. Leave "pick" tag in the first line.
27+
4. Change all other commits from "pick" to "fixup".
28+
5. Then do "force push" to overwrite remote history: ``git push -u origin ROCKETMQ-9999 --force``
29+
6. All your changes are now in a single commit, that would be much better for review.
30+
31+
More details of squash can be found at [stackoverflow](https://stackoverflow.com/questions/5189560/squash-my-last-x-commits-together-using-git).
32+
1633
## Becoming a Committer
1734

1835
We are always interested in adding new contributors. What we look for are series of contributions, good taste and ongoing interest in the project. If you are interested in becoming a committer, please let one of the existing committers know and they can help you walk through the process.
@@ -25,7 +42,7 @@ Nowadays,we have several important contribution points:
2542
##### Prerequisite
2643
If you want to contribute the above listing points, you must abide our some prerequisites:
2744

28-
###### Readability - API must have Javadoc,some very important methods also must have javadoc
45+
###### Readability - API must have Javadoc, some very important methods also must have javadoc
2946
###### Testability - 80% above unit test coverage about main process
3047
###### Maintainability - Comply with our [checkstyle spec](style/rmq_checkstyle.xml), and at least 3 month update frequency
3148
###### Deployability - We encourage you to deploy into [maven repository](http://search.maven.org/)

0 commit comments

Comments
 (0)