Skip to content

HDDS-15566. Move feature branch merge checklist to the website#463

Open
errose28 wants to merge 3 commits into
apache:masterfrom
errose28:worktree-branch-merge-checklist
Open

HDDS-15566. Move feature branch merge checklist to the website#463
errose28 wants to merge 3 commits into
apache:masterfrom
errose28:worktree-branch-merge-checklist

Conversation

@errose28

Copy link
Copy Markdown
Contributor

What changes were proposed in this pull request?

Move the feature branch merge checklist from confluence to the new website. As part of this change:

  • The checklist was updated
  • Docs on the project's git usage were rearranged to make room for the new content
  • All existing branch merge checklists from confluence were reformatted to markdown by AI and imported here
  • A process to raise new branch merge checklists as PRs to this repo for review is proposed

What is the link to the Apache Jira?

HDDS-15566

How was this patch tested?

Local preview

@errose28 errose28 requested a review from jojochuang June 15, 2026 23:46
@errose28 errose28 requested a review from adoroszlai June 16, 2026 00:01
@errose28

Copy link
Copy Markdown
Contributor Author

@gardenia This is the switch of the branch merge checklist to the new website I mentioned at the community sync.


3. If the vote passes, changes from the feature branch will be incorporated into `master`, and development can continue on the `master` branch.

**Do not use GitHub "Squash and merge" or rebase** to land the feature branch onto `master`. Use a **regular `git merge`** so history, Jira links, and PR discussions stay aligned with the original commit IDs.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

We need to decide what our actual guidelines are for:

  1. Updating feature branches with changes from master incrementally
  2. Incorporating the feature branch back into master

We want to avoid using merge for 1 and 2, because the layers of merge commits become difficult to follow when tracking the git history.

One option is using rebase to bring the commits into master. That will erase any merge commits on the branch so devs are free to use either rebase or merge to update their feature branch from master while working.

Another option is to rebase the feature branch and then merge it to master. This way master doesn't need to stay frozen while the feature branch rebase is happening. We may want to force a merge commit in this case even if it is not necessary for consistency across feature branch merges.

If there is another way to scrub the incremental merge commits before merging to master we could use that as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant