bschoening commented on code in PR #311: URL: https://github.com/apache/cassandra-website/pull/311#discussion_r3039732734
########## site-content/source/modules/ROOT/pages/development/how_to_commit.adoc: ########## @@ -4,10 +4,35 @@ Commits applicable to multiple versions are atomically pushed forward merges. -The fix lands on the oldest release branch and is then forward-merges it into each newer branch using an ours merge to record branch lineage and amends that merge commit to include the branch-appropriate patch. +Fixes are applied first on the oldest applicable release branch, and are then forward-merged onto each newer branch using an ours merge strategy to record branch lineage. Each forward-merge commit contains the branch-appropriate patch. This keeps a clean, traceable history and a single logical unit of work per ticket per branch, while preventing unintended diffs from being pulled forward automatically. +== Introduction for New Committers + +GitHub Pull Requests are merged using Git command-line tools instead of the GitHub UI. The following workflow outlines a standard trunk-only patching process; for contributions involving multiple branches, see the next section. + +Development occurs within personal forks, as the upstream apache/cassandra repository is strictly reserved for the trunk and official release branches. + +Use the following Git CLI commands when merging a PR: + +Step 1: From your project repository, check out a new branch and test the changes. +[source,shell] +---- +git checkout -b <jira>/<branch> <branch> +---- + +Step 2: Squash, fast-forward merge, and update on GitHub following the project workflow. +[source,shell] +---- +git switch trunk +# there should only be one commit, squashed +git cherry-pick <sha-of-commit> +# push as dry-run (-n) and check that it looks correct Review Comment: Need to update commit message in correct form (as discussed later) `git commit --amend` ########## site-content/source/modules/ROOT/pages/development/how_to_commit.adoc: ########## @@ -4,10 +4,35 @@ Commits applicable to multiple versions are atomically pushed forward merges. -The fix lands on the oldest release branch and is then forward-merges it into each newer branch using an ours merge to record branch lineage and amends that merge commit to include the branch-appropriate patch. +Fixes are applied first on the oldest applicable release branch, and are then forward-merged onto each newer branch using an ours merge strategy to record branch lineage. Each forward-merge commit contains the branch-appropriate patch. This keeps a clean, traceable history and a single logical unit of work per ticket per branch, while preventing unintended diffs from being pulled forward automatically. +== Introduction for New Committers + +GitHub Pull Requests are merged using Git command-line tools instead of the GitHub UI. The following workflow outlines a standard trunk-only patching process; for contributions involving multiple branches, see the next section. + +Development occurs within personal forks, as the upstream apache/cassandra repository is strictly reserved for the trunk and official release branches. + +Use the following Git CLI commands when merging a PR: + +Step 1: From your project repository, check out a new branch and test the changes. +[source,shell] +---- +git checkout -b <jira>/<branch> <branch> +---- + +Step 2: Squash, fast-forward merge, and update on GitHub following the project workflow. +[source,shell] +---- +git switch trunk +# there should only be one commit, squashed +git cherry-pick <sha-of-commit> +# push as dry-run (-n) and check that it looks correct +git push --atomic origin trunk -n Review Comment: Should it be upstream (github.com/apache/cassandra) not origin (your clone)? In which case, Step 1 needs to set upstream and verify ``` git remote add upstream https://gitbox.apache.org/repos/asf/cassandra.git git remote -v ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
