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: docs/dev-standards.md
+18Lines changed: 18 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -145,3 +145,21 @@ Similarly, if a dependency is changed, it's convenient to quickly spot this, e.g
145
145
146
146
The icon is metadata, not decoration.
147
147
It improves triage and doesn’t replace clear subjects/bodies.
148
+
149
+
## Collaboration on GitHub
150
+
151
+
### Review process
152
+
153
+
1.**Don't update the branch with merges, rebase instead.**
154
+
This makes the branches easier to understand, avoids merge commits (evil!), and allows for squashing commits as desired.
155
+
2.**Keep commits clean and as desired for the final PR merge.**
156
+
Adding commit after commit means the PR has to be reviewed in its entirety.
157
+
This is fine for smaller changes, but for more complicated PRs you should try to split up the relevant changes in atomic commits that deal with a single type/scope.
158
+
Keeping commits isolated and clean makes review easier, since each change can be reviewed in isolation, along with the explanation in the commit message.
159
+
Exceptions here are changes based on review, see the next point.
160
+
3.**Keep changes based on review in a single separate commit.**
161
+
After you are done with processing a review, you ping the reviewer again to see if they are happy with your updates.
162
+
However, how will they know what you have changed?
163
+
If you simply integrate the changes in the final commits, as described above, they can't isolate what you have changed based on their review.
164
+
If you add 10 more commits, it still is difficult to see what you changed in one view.
165
+
By keeping all the changes made based on a review in a single commit, you make subsequent review easier and faster.
0 commit comments