Skip to content
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ To commit a suggestion to your pull request, click on `Commit suggestion`:
If you want to commit multiple suggestions, go to the "Files changed" tab and batch all suggestions. Now, click the `Commit suggestions` button and enter a commit message to create a single commit.

> [!IMPORTANT]
> Do not force push. We would prefer to preserve commit history so that the order of events is preserved. All pull requests will be squashed so a messy pull request will not matter.
> Do not force push. We would prefer to preserve commit history within the pull request so that the order of events stays chronological. All pull requests will be squashed so the mess will be contained in the PR.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not so sure this improves clarity.

For example, adding within the pull request suggests that preservation of event order matters only inside the PR, and not e.g. on the main branch.

In the same vein, the mess will be contained in the PR seems a little vague compared to the previous wording, and also conflicts with the above.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For example, adding within the pull request suggests that preservation of event order matters only inside the PR, and not e.g. on the main branch.

I fail to see the problem here. If PR's are squashed, nobody needs to think about the main branch.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From that perspective, why is it that we e.g. do a traditional merge, instead of our current policy of squash+merge?

I was under the impression that it was to ensure the history on the main branch was clean and easy to understand?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think these are in opposition. Anyways, I made a new commit that adjusts the wording a little bit ca43858

### Commit message and PR title

Expand Down
Loading