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
+19-5Lines changed: 19 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -117,12 +117,12 @@ At this stage, one should expect comments and review from other contributors. Yo
117
117
can add more commits to your pull request by committing them locally and pushing
118
118
to your fork until you have satisfied all feedback.
119
119
120
-
Note: Code review is a burdensome but important part of the development process, and as such, certain types of pull requests are rejected. In general, if the **improvements** do not warrant the **review effort** required, the PR has a high chance of being rejected. It is up to the PR author to convince the reviewers that the changes warrant the review effort, and if reviewers are "Concept NAK'ing" the PR, the author may need to present arguments and/or do research backing their suggested changes.
120
+
Note: Code review is a burdensome but important part of the development process, and as such, certain types of pull requests are rejected. In general, if the **improvements** do not warrant the **review effort** required, the PR has a high chance of being rejected. It is up to the PR author to convince the reviewers that the changes warrant the review effort, and if reviewers are "Concept NACK'ing" the PR, the author may need to present arguments and/or do research backing their suggested changes.
121
121
122
-
Squashing Commits
123
-
---------------------------
124
-
If your pull request is accepted for merging, you may be asked by a maintainer
125
-
to squash and or [rebase](https://git-scm.com/docs/git-rebase) your commits
122
+
### Squashing Commits
123
+
124
+
If your pull request contains fixup commits (commits that change the same line of code repeatedly) or too fine-grained
125
+
commits, you may be asked to [squash](https://git-scm.com/docs/git-rebase#_interactive_mode) your commits
126
126
before it will be merged. The basic squashing workflow is shown below.
127
127
128
128
git checkout your_branch_name
@@ -149,6 +149,20 @@ the respective change set.
149
149
The length of time required for peer review is unpredictable and will vary from
150
150
pull request to pull request.
151
151
152
+
### Rebasing Changes
153
+
154
+
When a pull request conflicts with the target branch, you may be asked to rebase it on top of the current target branch.
155
+
The `git rebase` command will take care of rebuilding your commits on top of the new base.
156
+
157
+
This project aims to have a clean git history, where code changes are only made in non-merge commits. This simplifies
158
+
auditability because merge commits can be assumed to not contain arbitrary code changes. Merge commits should be signed,
159
+
and the resulting git tree hash must be deterministic and reproducible. The script in
0 commit comments