You are viewing a plain text version of this content. The canonical link for it is here.
Posted to pr@cassandra.apache.org by "arvindKandpal-ksolves (via GitHub)" <gi...@apache.org> on 2026/03/09 10:09:23 UTC
[PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
arvindKandpal-ksolves opened a new pull request, #311:
URL: https://github.com/apache/cassandra-website/pull/311
### Why is this PR being submitted?
This PR resolves CASSANDRA-19777.
New committers often need a quick overview of the expected Git workflow before diving into the specific patch/branch-based contribution steps. This PR adds a brief introduction to the `how_to_commit` documentation to outline these prerequisites, as requested in the Jira ticket, without turning the page into a full Git tutorial.
### What changes were made?
Added a new `== Introduction for New Committers` section to `how_to_commit.adoc` which covers:
* The preference for using the Git CLI over the GitHub Web UI.
* The requirement to use local feature branches and never push a branch directly upstream.
* The squash-rebase-merge workflow.
* Essential git commands (`remote add`, `rebase -i`, `commit --amend`, `push --atomic -n`).
* The GitHub CLI commands for locally testing and merging a PR.
--
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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
Posted by "michaelsembwever (via GitHub)" <gi...@apache.org>.
michaelsembwever commented on code in PR #311:
URL: https://github.com/apache/cassandra-website/pull/311#discussion_r2910063752
##########
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.
+Fix land on the oldest 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
+
+To be an effective committer, you should be familiar with the following git command lines. The following outlines the simple trunk-only patch workflow. See next section for multi-branch contributions.
+
+* **Local feature branches:** Always do your work in a local feature/topic branch. Do not push your personal feature branches upstream; only the canonical trunk and release branches should be pushed to the shared repository when merging changes.
Review Comment:
```suggestion
Patches are applied using git command lines, not via github UI. The following outlines the simple trunk-only patch workflow. See next section for multi-branch contributions.
Development branches are kept in forks. The upstream apache/cassandra repository is reserved for trunk and release branches.
```
--
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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
Posted by "michaelsembwever (via GitHub)" <gi...@apache.org>.
michaelsembwever closed pull request #311: CASSANDRA-19777: Update doc page for how-to commit with more intro
URL: https://github.com/apache/cassandra-website/pull/311
--
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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #311:
URL: https://github.com/apache/cassandra-website/pull/311#discussion_r2908127323
##########
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc:
##########
@@ -8,6 +8,36 @@ The fix lands on the oldest release branch and is then forward-merges it into ea
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
+
+To be an effective committer, you should be familiar with the following background details. While this is not a git tutorial, it outlines the expected workflow:
+
+* **Using CLI vs GitHub web UI:** We recommend using the Git CLI rather than the GitHub web UI.
+* **Local feature branches:** Always do your work in a local branch, and never push a branch upstream.
+* **Workflow:** This repository uses a squash-rebase-merge workflow with feature branches.
Review Comment:
The intro says the repo uses a “squash-rebase-merge” workflow, but the rest of this document describes forward-merges with `-s ours` and `git commit --amend` (and the new example below uses `git merge --no-ff`). Please align this wording with the actual documented workflow (or update the example and later sections accordingly) to avoid giving new committers contradictory instructions.
```suggestion
* **Workflow:** This repository uses a forward-merge workflow: fixes land on the oldest supported branch and are merged forward into newer branches (using ours merges and amended merge commits).
```
##########
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc:
##########
@@ -8,6 +8,36 @@ The fix lands on the oldest release branch and is then forward-merges it into ea
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
+
+To be an effective committer, you should be familiar with the following background details. While this is not a git tutorial, it outlines the expected workflow:
+
+* **Using CLI vs GitHub web UI:** We recommend using the Git CLI rather than the GitHub web UI.
+* **Local feature branches:** Always do your work in a local branch, and never push a branch upstream.
+* **Workflow:** This repository uses a squash-rebase-merge workflow with feature branches.
+* **Basic git commands you should know:**
+** `git remote add` & `git remote set-url`
+** Squashing commits with `git rebase -i`
+** Updating a commit with `git commit --amend`
+** `git push upstream <repo> --atomic -n`
+
+GitHub offers these CLI commands for merging a PR:
+
+Step 1: From your project repository, check out a new branch and test the changes.
+[source,shell]
+----
+git checkout -b omniCoder77-feature/guardrail-for-misprepare-statements trunk
+git pull https://github.com/omniCoder77/cassandra.git feature/guardrail-for-misprepare-statements
+----
+
+Step 2: Merge the changes and update on GitHub.
+[source,shell]
+----
+git checkout trunk
+git merge --no-ff omniCoder77-feature/guardrail-for-misprepare-statements
Review Comment:
The example uses a specific username/repo and very specific branch names (`omniCoder77`, `guardrail-for-misprepare-statements`). For project documentation this should be generalized to placeholders (e.g., `<github_username>`, `<fork_remote>`, `<pr_branch>`), so readers don’t copy/paste misleading values.
```suggestion
git checkout -b <github_username>-feature/<pr_branch> trunk
git pull https://github.com/<github_username>/<repo_name>.git <pr_branch>
----
Step 2: Merge the changes and update on GitHub.
[source,shell]
----
git checkout trunk
git merge --no-ff <github_username>-feature/<pr_branch>
```
##########
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc:
##########
@@ -8,6 +8,36 @@ The fix lands on the oldest release branch and is then forward-merges it into ea
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
+
+To be an effective committer, you should be familiar with the following background details. While this is not a git tutorial, it outlines the expected workflow:
+
+* **Using CLI vs GitHub web UI:** We recommend using the Git CLI rather than the GitHub web UI.
+* **Local feature branches:** Always do your work in a local branch, and never push a branch upstream.
Review Comment:
“Never push a branch upstream” is ambiguous in this context because later steps require pushing the release/trunk branches (e.g., `git push origin ...`). Consider clarifying that this refers to *feature/topic* branches only, and that only the canonical branches should be pushed when committing.
```suggestion
* **Local feature branches:** Always do your work in a local feature/topic branch. Do not push your personal feature branches upstream; only the canonical trunk and release branches should be pushed to the shared repository when merging changes.
```
##########
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc:
##########
@@ -8,6 +8,36 @@ The fix lands on the oldest release branch and is then forward-merges it into ea
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
+
+To be an effective committer, you should be familiar with the following background details. While this is not a git tutorial, it outlines the expected workflow:
+
+* **Using CLI vs GitHub web UI:** We recommend using the Git CLI rather than the GitHub web UI.
+* **Local feature branches:** Always do your work in a local branch, and never push a branch upstream.
+* **Workflow:** This repository uses a squash-rebase-merge workflow with feature branches.
+* **Basic git commands you should know:**
+** `git remote add` & `git remote set-url`
+** Squashing commits with `git rebase -i`
+** Updating a commit with `git commit --amend`
+** `git push upstream <repo> --atomic -n`
+
+GitHub offers these CLI commands for merging a PR:
+
+Step 1: From your project repository, check out a new branch and test the changes.
+[source,shell]
+----
+git checkout -b omniCoder77-feature/guardrail-for-misprepare-statements trunk
+git pull https://github.com/omniCoder77/cassandra.git feature/guardrail-for-misprepare-statements
+----
+
+Step 2: Merge the changes and update on GitHub.
+[source,shell]
+----
+git checkout trunk
+git merge --no-ff omniCoder77-feature/guardrail-for-misprepare-statements
+git push origin trunk
Review Comment:
Step 2 uses `git merge --no-ff` into `trunk`, which produces a merge commit and doesn’t match the earlier “squash” wording or the forward-merge + `--amend` procedure described later in this document. Please adjust the example to match the intended Cassandra committer workflow so new committers aren’t guided toward the wrong merge strategy.
```suggestion
Step 2: Squash, fast-forward merge, and update on GitHub following the project workflow.
[source,shell]
----
git checkout omniCoder77-feature/guardrail-for-misprepare-statements
git rebase -i trunk # squash to a single, well-titled commit
git checkout trunk
git merge --ff-only omniCoder77-feature/guardrail-for-misprepare-statements
git push upstream trunk --atomic
```
##########
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc:
##########
@@ -8,6 +8,36 @@ The fix lands on the oldest release branch and is then forward-merges it into ea
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
+
+To be an effective committer, you should be familiar with the following background details. While this is not a git tutorial, it outlines the expected workflow:
+
+* **Using CLI vs GitHub web UI:** We recommend using the Git CLI rather than the GitHub web UI.
+* **Local feature branches:** Always do your work in a local branch, and never push a branch upstream.
+* **Workflow:** This repository uses a squash-rebase-merge workflow with feature branches.
+* **Basic git commands you should know:**
+** `git remote add` & `git remote set-url`
+** Squashing commits with `git rebase -i`
+** Updating a commit with `git commit --amend`
+** `git push upstream <repo> --atomic -n`
+
+GitHub offers these CLI commands for merging a PR:
Review Comment:
This sentence says “GitHub offers these CLI commands”, but the commands shown are plain `git` commands (not GitHub CLI `gh ...`). Either update the wording to refer to Git commands, or replace the example with the actual GitHub CLI flow (e.g., `gh pr checkout ...`, `gh pr merge ...`) that the PR description mentions.
```suggestion
Use the following Git CLI commands when merging a PR:
```
##########
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc:
##########
@@ -8,6 +8,36 @@ The fix lands on the oldest release branch and is then forward-merges it into ea
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
+
+To be an effective committer, you should be familiar with the following background details. While this is not a git tutorial, it outlines the expected workflow:
+
+* **Using CLI vs GitHub web UI:** We recommend using the Git CLI rather than the GitHub web UI.
+* **Local feature branches:** Always do your work in a local branch, and never push a branch upstream.
+* **Workflow:** This repository uses a squash-rebase-merge workflow with feature branches.
+* **Basic git commands you should know:**
+** `git remote add` & `git remote set-url`
+** Squashing commits with `git rebase -i`
+** Updating a commit with `git commit --amend`
+** `git push upstream <repo> --atomic -n`
+
+GitHub offers these CLI commands for merging a PR:
+
+Step 1: From your project repository, check out a new branch and test the changes.
+[source,shell]
+----
+git checkout -b omniCoder77-feature/guardrail-for-misprepare-statements trunk
+git pull https://github.com/omniCoder77/cassandra.git feature/guardrail-for-misprepare-statements
Review Comment:
`git pull <url> <branch>` performs a fetch+merge and can create an unnecessary merge commit in the local branch. For an instructional example, prefer an explicit `git fetch` + `git checkout` (or `gh pr checkout`) flow so testing the PR doesn’t accidentally change history.
```suggestion
git fetch https://github.com/omniCoder77/cassandra.git feature/guardrail-for-misprepare-statements:omniCoder77-feature/guardrail-for-misprepare-statements
git checkout omniCoder77-feature/guardrail-for-misprepare-statements
```
##########
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc:
##########
@@ -8,6 +8,36 @@ The fix lands on the oldest release branch and is then forward-merges it into ea
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
+
+To be an effective committer, you should be familiar with the following background details. While this is not a git tutorial, it outlines the expected workflow:
+
+* **Using CLI vs GitHub web UI:** We recommend using the Git CLI rather than the GitHub web UI.
+* **Local feature branches:** Always do your work in a local branch, and never push a branch upstream.
+* **Workflow:** This repository uses a squash-rebase-merge workflow with feature branches.
+* **Basic git commands you should know:**
+** `git remote add` & `git remote set-url`
+** Squashing commits with `git rebase -i`
+** Updating a commit with `git commit --amend`
+** `git push upstream <repo> --atomic -n`
Review Comment:
`git push upstream <repo> --atomic -n` doesn’t look like a valid/meaningful `git push` invocation here (`<repo>` isn’t a refspec), and this page otherwise uses `origin` (no `upstream` remote is introduced). Suggest updating this to match the established commands below (e.g., `git push origin <branches> --atomic -n`) or explicitly defining the intended remote/refspec placeholders.
```suggestion
** `git push origin <branches> --atomic -n`
```
--
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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
Posted by "michaelsembwever (via GitHub)" <gi...@apache.org>.
michaelsembwever commented on code in PR #311:
URL: https://github.com/apache/cassandra-website/pull/311#discussion_r2910033783
##########
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc:
##########
@@ -4,10 +4,37 @@
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.
+Fix land on the oldest 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
+
+To be an effective committer, you should be familiar with the following background details. While this is not a git tutorial, it outlines the expected workflow:
+
+* **Using CLI vs GitHub web UI:** We recommend using the Git CLI rather than the GitHub web UI.
Review Comment:
```suggestion
To be an effective committer, you should be familiar with the following git command lines. The following outlines the simple trunk-only patch workflow. See next section for multi-branch contributions
* **Using CLI vs GitHub web UI:** We recommend using the Git CLI rather than the GitHub web UI.
```
--
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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
Posted by "bschoening (via GitHub)" <gi...@apache.org>.
bschoening commented on code in PR #311:
URL: https://github.com/apache/cassandra-website/pull/311#discussion_r3031069931
##########
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
+
+Patches are applied using git command lines, not via github UI. The following outlines the simple trunk-only patch workflow. See next section for multi-branch contributions.
+
+Development branches are kept in forks. The upstream apache/cassandra repository is reserved for trunk and 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 <jira>/<branch>
+git push --atomic origin trunk -n
+# check dry-run looks correct
Review Comment:
shouldn't the dry run comment (-n) be before the command not after? I realize it's suggesting to check afterwards, but might be be more clear if the dry run was explained before executed.
``# push as dry-run (-n) and check that it looks correct
--
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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
Posted by "michaelsembwever (via GitHub)" <gi...@apache.org>.
michaelsembwever commented on code in PR #311:
URL: https://github.com/apache/cassandra-website/pull/311#discussion_r2909952763
##########
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc:
##########
Review Comment:
```suggestion
Fix land on the oldest 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 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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
Posted by "bschoening (via GitHub)" <gi...@apache.org>.
bschoening commented on code in PR #311:
URL: https://github.com/apache/cassandra-website/pull/311#discussion_r3031069931
##########
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
+
+Patches are applied using git command lines, not via github UI. The following outlines the simple trunk-only patch workflow. See next section for multi-branch contributions.
+
+Development branches are kept in forks. The upstream apache/cassandra repository is reserved for trunk and 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 <jira>/<branch>
+git push --atomic origin trunk -n
+# check dry-run looks correct
Review Comment:
shouldn't the dry run comment (-n) be before the command not after? I realize it's suggesting to check afterwards, but might be be more clear if the dry run was explained before executed.
# push as dry-run (-n) and check that it looks correct
##########
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
+
+Patches are applied using git command lines, not via github UI. The following outlines the simple trunk-only patch workflow. See next section for multi-branch contributions.
+
+Development branches are kept in forks. The upstream apache/cassandra repository is reserved for trunk and 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 <jira>/<branch>
Review Comment:
cherry pick a branch or commit-hash?
##########
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc:
##########
@@ -8,6 +8,36 @@ The fix lands on the oldest release branch and is then forward-merges it into ea
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
+
+To be an effective committer, you should be familiar with the following background details. While this is not a git tutorial, it outlines the expected workflow:
+
+* **Using CLI vs GitHub web UI:** We recommend using the Git CLI rather than the GitHub web UI.
+* **Local feature branches:** Always do your work in a local branch, and never push a branch upstream.
+* **Workflow:** This repository uses a squash-rebase-merge workflow with feature branches.
+* **Basic git commands you should know:**
+** `git remote add` & `git remote set-url`
+** Squashing commits with `git rebase -i`
+** Updating a commit with `git commit --amend`
+** `git push upstream <repo> --atomic -n`
+
+GitHub offers these CLI commands for merging a PR:
Review Comment:
Should be git commands, not github
##########
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
+
+Patches are applied using git command lines, not via github UI. The following outlines the simple trunk-only patch workflow. See next section for multi-branch contributions.
+
+Development branches are kept in forks. The upstream apache/cassandra repository is reserved for trunk and release branches.
Review Comment:
Development occurs within personal forks, as the upstream ``apache/cassandra`` repository is strictly reserved for the trunk and official release branches.
##########
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc:
##########
@@ -8,6 +8,36 @@ The fix lands on the oldest release branch and is then forward-merges it into ea
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
+
+To be an effective committer, you should be familiar with the following background details. While this is not a git tutorial, it outlines the expected workflow:
+
+* **Using CLI vs GitHub web UI:** We recommend using the Git CLI rather than the GitHub web UI.
Review Comment:
but why?
##########
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc:
##########
@@ -8,6 +8,36 @@ The fix lands on the oldest release branch and is then forward-merges it into ea
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
+
+To be an effective committer, you should be familiar with the following background details. While this is not a git tutorial, it outlines the expected workflow:
+
+* **Using CLI vs GitHub web UI:** We recommend using the Git CLI rather than the GitHub web UI.
+* **Local feature branches:** Always do your work in a local branch, and never push a branch upstream.
+* **Workflow:** This repository uses a squash-rebase-merge workflow with feature branches.
+* **Basic git commands you should know:**
+** `git remote add` & `git remote set-url`
+** Squashing commits with `git rebase -i`
+** Updating a commit with `git commit --amend`
+** `git push upstream <repo> --atomic -n`
+
+GitHub offers these CLI commands for merging a PR:
+
+Step 1: From your project repository, check out a new branch and test the changes.
+[source,shell]
+----
+git checkout -b omniCoder77-feature/guardrail-for-misprepare-statements trunk
+git pull https://github.com/omniCoder77/cassandra.git feature/guardrail-for-misprepare-statements
Review Comment:
It's general practice to use branch names with the Jira ID in the name, e.g. CASSANDRA-9999. You can look at some open PRs for examples.
##########
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
+
+Patches are applied using git command lines, not via github UI. The following outlines the simple trunk-only patch workflow. See next section for multi-branch contributions.
Review Comment:
Suggest:
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.
--
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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
Posted by "bschoening (via GitHub)" <gi...@apache.org>.
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:
Think one needs to update commit message in correct form (as discussed later in doc)
`git commit --amend`
--
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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
Posted by "michaelsembwever (via GitHub)" <gi...@apache.org>.
michaelsembwever commented on code in PR #311:
URL: https://github.com/apache/cassandra-website/pull/311#discussion_r2910033783
##########
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc:
##########
@@ -4,10 +4,37 @@
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.
+Fix land on the oldest 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
+
+To be an effective committer, you should be familiar with the following background details. While this is not a git tutorial, it outlines the expected workflow:
+
+* **Using CLI vs GitHub web UI:** We recommend using the Git CLI rather than the GitHub web UI.
Review Comment:
```suggestion
Patches are applied using git command lines, not via github UI. The following outlines the simple trunk-only patch workflow. See next section for multi-branch contributions.
```
--
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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
Posted by "michaelsembwever (via GitHub)" <gi...@apache.org>.
michaelsembwever commented on code in PR #311:
URL: https://github.com/apache/cassandra-website/pull/311#discussion_r2910010722
##########
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc:
##########
@@ -8,6 +8,38 @@ The fix lands on the oldest release branch and is then forward-merges it into ea
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
+
+To be an effective committer, you should be familiar with the following background details. While this is not a git tutorial, it outlines the expected workflow:
+
+* **Using CLI vs GitHub web UI:** We recommend using the Git CLI rather than the GitHub web UI.
+* **Local feature branches:** Always do your work in a local feature/topic branch. Do not push your personal feature branches upstream; only the canonical trunk and release branches should be pushed to the shared repository when merging changes.
+* **Workflow:** This repository uses a squash-rebase-merge workflow with feature branches. Fixes land on the oldest supported branch and are merged forward into newer branches (using ours merges and amended merge commits).
Review Comment:
remove. not applicable to this section.
```suggestion
```
--
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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
Posted by "michaelsembwever (via GitHub)" <gi...@apache.org>.
michaelsembwever commented on PR #311:
URL: https://github.com/apache/cassandra-website/pull/311#issuecomment-4263449756
Committed with https://github.com/apache/cassandra-website/commit/732d43980e4dd84ebf98c777f58df7261e34a419
(took the ticket id out of the first line)
--
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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
Posted by "bschoening (via GitHub)" <gi...@apache.org>.
bschoening commented on code in PR #311:
URL: https://github.com/apache/cassandra-website/pull/311#discussion_r3031069931
##########
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
+
+Patches are applied using git command lines, not via github UI. The following outlines the simple trunk-only patch workflow. See next section for multi-branch contributions.
+
+Development branches are kept in forks. The upstream apache/cassandra repository is reserved for trunk and 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 <jira>/<branch>
+git push --atomic origin trunk -n
+# check dry-run looks correct
Review Comment:
shouldn't the dry run comment (-n) be before the command not after? I realize it's suggesting to check afterwards, but might be be more clear if the dry run was explained before executed.
``# push as dry-run (-n) and check that it looks correct``
--
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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
Posted by "michaelsembwever (via GitHub)" <gi...@apache.org>.
michaelsembwever commented on code in PR #311:
URL: https://github.com/apache/cassandra-website/pull/311#discussion_r3004575584
##########
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.
+Fix land on the oldest 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.
Review Comment:
sry, one more attempt…
```suggestion
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 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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
Posted by "michaelsembwever (via GitHub)" <gi...@apache.org>.
michaelsembwever commented on code in PR #311:
URL: https://github.com/apache/cassandra-website/pull/311#discussion_r2910033783
##########
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc:
##########
@@ -4,10 +4,37 @@
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.
+Fix land on the oldest 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
+
+To be an effective committer, you should be familiar with the following background details. While this is not a git tutorial, it outlines the expected workflow:
+
+* **Using CLI vs GitHub web UI:** We recommend using the Git CLI rather than the GitHub web UI.
Review Comment:
```suggestion
To be an effective committer, you should be familiar with the following git command lines. The following outlines the simple trunk-only patch workflow. See next section for multi-branch contributions.
```
--
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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
Posted by "arvindKandpal-ksolves (via GitHub)" <gi...@apache.org>.
arvindKandpal-ksolves commented on PR #311:
URL: https://github.com/apache/cassandra-website/pull/311#issuecomment-4028760966
Hi @bschoening , I have applied Copilot suggestions , Please take a look.
--
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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
Posted by "bschoening (via GitHub)" <gi...@apache.org>.
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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
Posted by "michaelsembwever (via GitHub)" <gi...@apache.org>.
michaelsembwever commented on PR #311:
URL: https://github.com/apache/cassandra-website/pull/311#issuecomment-4247714718
@arvindKandpal-ksolves , i think we're good to go here, are you happy to squash all your commits to one, write up the commit message (to the project standard), and force push your branch here ?
--
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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
Posted by "michaelsembwever (via GitHub)" <gi...@apache.org>.
michaelsembwever commented on code in PR #311:
URL: https://github.com/apache/cassandra-website/pull/311#discussion_r2910046757
##########
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.
+Fix land on the oldest 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
+
+To be an effective committer, you should be familiar with the following git command lines. The following outlines the simple trunk-only patch workflow. See next section for multi-branch contributions.
Review Comment:
```suggestion
Patches are applied using git command lines, not via github UI. The following outlines the simple trunk-only patch workflow. See next section for multi-branch contributions.
```
--
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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
Posted by "michaelsembwever (via GitHub)" <gi...@apache.org>.
michaelsembwever commented on code in PR #311:
URL: https://github.com/apache/cassandra-website/pull/311#discussion_r2909965196
##########
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc:
##########
@@ -8,6 +8,38 @@ The fix lands on the oldest release branch and is then forward-merges it into ea
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
+
+To be an effective committer, you should be familiar with the following background details. While this is not a git tutorial, it outlines the expected workflow:
+
+* **Using CLI vs GitHub web UI:** We recommend using the Git CLI rather than the GitHub web UI.
+* **Local feature branches:** Always do your work in a local feature/topic branch. Do not push your personal feature branches upstream; only the canonical trunk and release branches should be pushed to the shared repository when merging changes.
+* **Workflow:** This repository uses a squash-rebase-merge workflow with feature branches. Fixes land on the oldest supported branch and are merged forward into newer branches (using ours merges and amended merge commits).
+* **Basic git commands you should know:**
+** `git remote add` & `git remote set-url`
+** Squashing commits with `git rebase -i`
+** Updating a commit with `git commit --amend`
+** `git push origin <branches> --atomic -n`
+
+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 <github_username>-feature/<pr_branch> trunk
+git fetch https://github.com/<github_username>/<repo_name>.git <pr_branch>:<github_username>-feature/<pr_branch>
+git checkout <github_username>-feature/<pr_branch>
Review Comment:
```suggestion
git checkout -b <jira>/<branch> <branch>
```
--
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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
Posted by "michaelsembwever (via GitHub)" <gi...@apache.org>.
michaelsembwever commented on code in PR #311:
URL: https://github.com/apache/cassandra-website/pull/311#discussion_r2910005978
##########
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc:
##########
@@ -8,6 +8,38 @@ The fix lands on the oldest release branch and is then forward-merges it into ea
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
+
+To be an effective committer, you should be familiar with the following background details. While this is not a git tutorial, it outlines the expected workflow:
+
+* **Using CLI vs GitHub web UI:** We recommend using the Git CLI rather than the GitHub web UI.
+* **Local feature branches:** Always do your work in a local feature/topic branch. Do not push your personal feature branches upstream; only the canonical trunk and release branches should be pushed to the shared repository when merging changes.
+* **Workflow:** This repository uses a squash-rebase-merge workflow with feature branches. Fixes land on the oldest supported branch and are merged forward into newer branches (using ours merges and amended merge commits).
+* **Basic git commands you should know:**
+** `git remote add` & `git remote set-url`
+** Squashing commits with `git rebase -i`
+** Updating a commit with `git commit --amend`
+** `git push origin <branches> --atomic -n`
Review Comment:
remove, no added value here
```suggestion
```
--
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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSANDRA-19777: Update doc page for how-to commit with more intro [cassandra-website]
Posted by "michaelsembwever (via GitHub)" <gi...@apache.org>.
michaelsembwever commented on code in PR #311:
URL: https://github.com/apache/cassandra-website/pull/311#discussion_r2910002098
##########
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc:
##########
@@ -8,6 +8,38 @@ The fix lands on the oldest release branch and is then forward-merges it into ea
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
+
+To be an effective committer, you should be familiar with the following background details. While this is not a git tutorial, it outlines the expected workflow:
+
+* **Using CLI vs GitHub web UI:** We recommend using the Git CLI rather than the GitHub web UI.
+* **Local feature branches:** Always do your work in a local feature/topic branch. Do not push your personal feature branches upstream; only the canonical trunk and release branches should be pushed to the shared repository when merging changes.
+* **Workflow:** This repository uses a squash-rebase-merge workflow with feature branches. Fixes land on the oldest supported branch and are merged forward into newer branches (using ours merges and amended merge commits).
+* **Basic git commands you should know:**
+** `git remote add` & `git remote set-url`
+** Squashing commits with `git rebase -i`
+** Updating a commit with `git commit --amend`
+** `git push origin <branches> --atomic -n`
+
+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 <github_username>-feature/<pr_branch> trunk
+git fetch https://github.com/<github_username>/<repo_name>.git <pr_branch>:<github_username>-feature/<pr_branch>
+git checkout <github_username>-feature/<pr_branch>
+----
+
+Step 2: Squash, fast-forward merge, and update on GitHub following the project workflow.
+[source,shell]
+----
+git rebase -i trunk # squash to a single, well-titled commit
+git checkout trunk
+git merge --ff-only <github_username>-feature/<pr_branch>
+git push origin trunk --atomic
Review Comment:
```suggestion
git switch trunk
# there should only be one commit, squashed
git cherry-pick <jira>/<branch>
git push --atomic origin trunk -n
# check dry-run looks correct
git push --atomic origin trunk
```
--
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: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org