Skip to content

Commit 0050981

Browse files
[FAB-3058] CONTRIBUTING improvements
Make inclusion of JIRA link mandatory, add improved guidance for change requests. Change-Id: I5cd2e39e4fb4b3df486fdfa3a349dd328eb6972d Signed-off-by: Christopher Ferris <[email protected]>
1 parent 7984725 commit 0050981

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

docs/source/CONTRIBUTING.rst

+17-5
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Fixing issues and working stories
7373
Review the `issues
7474
list <https://github.com/hyperledger/fabric/issues>`__ and find
7575
something that interests you. You could also check the
76-
`"help-wanted" <https://jira.hyperledger.org/issues/?jql=project%20%3D%20Fabric%20AND%20labels%20%3D%20help-wanted>`__
76+
`"help-wanted" <https://jira.hyperledger.org/issues/?filter=10147>`__
7777
list. It is wise to start with something relatively straight forward and
7878
achievable, and that no one is already assigned. If no one is assigned,
7979
then assign the issue to yourself. Please be considerate and rescind the
@@ -140,7 +140,7 @@ What makes a good change request?
140140
- Minimize the lines of code per CR. Why? Maintainers have day jobs,
141141
too. If you send a 1,000 or 2,000 LOC change, how long do you think
142142
it takes to review all of that code? Keep your changes to < 200-300
143-
LOC if possible. If you have a larger change, decompose it into
143+
LOC, if possible. If you have a larger change, decompose it into
144144
multiple independent changess. If you are adding a bunch of new
145145
functions to fulfill the requirements of a new capability, add them
146146
separately with their tests, and then write the code that uses them
@@ -150,12 +150,24 @@ What makes a good change request?
150150
bunch of generated code (protobufs, etc.). Again, there can be
151151
exceptions.
152152

153+
Note: large change requests, e.g. those with more than 300 LOC are more likely
154+
than not going to receive a -2, and you'll be asked to refactor the change
155+
to conform with this guidance.
156+
157+
- Do not stack change requests (e.g. submit a CR from the same local branch
158+
as your previous CR) unless they are related. This will minimize merge
159+
conflicts and allow changes to be merged more quickly. If you stack requests
160+
your subsequent requests may be held up because of review comments in the
161+
preceding requests.
162+
153163
- Write a meaningful commit message. Include a meaningful 50 (or less)
154-
character title, followed by a blank line, followed my a more
155-
comprehensive description of the change. Be sure to include the JIRA
164+
character title, followed by a blank line, followed by a more
165+
comprehensive description of the change. Each change MUST include the JIRA
156166
identifier corresponding to the change (e.g. [FAB-1234]). This can be
157167
in the title but should also be in the body of the commit message.
158168

169+
Note that Gerrit will automatically create a hyperlink to the JIRA item.
170+
159171
e.g.
160172

161173
::
@@ -177,7 +189,7 @@ Be sure to check out the language-specific `style
177189
guides <Style-guides/go-style.md>`__ before making any changes. This
178190
will ensure a smoother review.
179191

180-
Communication
192+
Communication
181193
--------------
182194

183195
We use `RocketChat <https://chat.hyperledger.org/>`__ for communication

0 commit comments

Comments
 (0)