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: [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]
