You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+18-1
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,10 @@ We want to have high quality, well documented codes for each programming languag
5
5
6
6
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.
To submit a change for inclusion, please do the following:
@@ -13,6 +17,19 @@ To submit a change for inclusion, please do the following:
13
17
#### 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.
14
18
#### 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).
15
19
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
+
16
33
## Becoming a Committer
17
34
18
35
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:
25
42
##### Prerequisite
26
43
If you want to contribute the above listing points, you must abide our some prerequisites:
27
44
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
29
46
###### Testability - 80% above unit test coverage about main process
30
47
###### Maintainability - Comply with our [checkstyle spec](style/rmq_checkstyle.xml), and at least 3 month update frequency
31
48
###### Deployability - We encourage you to deploy into [maven repository](http://search.maven.org/)
0 commit comments