CASSANDRA-19777: Update doc page for how-to commit with more intro#311
Open
arvindKandpal-ksolves wants to merge 9 commits intoapache:trunkfrom
Open
CASSANDRA-19777: Update doc page for how-to commit with more intro#311arvindKandpal-ksolves wants to merge 9 commits intoapache:trunkfrom
arvindKandpal-ksolves wants to merge 9 commits intoapache:trunkfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Updates Cassandra’s committer documentation (how_to_commit.adoc) to add a short “Introduction for New Committers” section that summarizes expected Git workflow prerequisites before the existing branch/patch-based contribution instructions.
Changes:
- Adds an introductory section describing preferred tooling (CLI), use of local feature branches, and a high-level workflow summary.
- Adds a short list of “basic git commands” and an example sequence intended to show how to locally test and merge a PR.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc
Outdated
Show resolved
Hide resolved
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc
Outdated
Show resolved
Hide resolved
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc
Outdated
Show resolved
Hide resolved
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc
Outdated
Show resolved
Hide resolved
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc
Outdated
Show resolved
Hide resolved
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc
Outdated
Show resolved
Hide resolved
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc
Outdated
Show resolved
Hide resolved
patch by Arvind Kandpal; for CASSANDRA-19777
arvindKandpal-ksolves
force-pushed
the
CASSANDRA-19777
branch
from
bc66225 to
d80e53c
Compare
Contributor
Author
|
Hi @bschoening , I have applied Copilot suggestions , Please take a look. |
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc
Outdated
Show resolved
Hide resolved
…it.adoc Co-authored-by: mck <mck@apache.org>
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc
Outdated
Show resolved
Hide resolved
…it.adoc Co-authored-by: mck <mck@apache.org>
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc
Outdated
Show resolved
Hide resolved
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc
Outdated
Show resolved
Hide resolved
…it.adoc Co-authored-by: mck <mck@apache.org>
…it.adoc Co-authored-by: mck <mck@apache.org>
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc
Outdated
Show resolved
Hide resolved
…it.adoc Co-authored-by: mck <mck@apache.org>
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc
Outdated
Show resolved
Hide resolved
…it.adoc Co-authored-by: mck <mck@apache.org>
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc
Outdated
Show resolved
Hide resolved
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc
Outdated
Show resolved
Hide resolved
…it.adoc Co-authored-by: mck <mck@apache.org>
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc
Outdated
Show resolved
Hide resolved
michaelsembwever
approved these changes
Mar 28, 2026
Member
michaelsembwever
left a comment
michaelsembwever
left a comment
There was a problem hiding this comment.
one more nit suggestion, otherwise good to go
…it.adoc Co-authored-by: mck <mck@apache.org>
bschoening
requested changes
Apr 3, 2026
|
|
||
| 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. |
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc
Outdated
Show resolved
Hide resolved
site-content/source/modules/ROOT/pages/development/how_to_commit.adoc
Outdated
Show resolved
Hide resolved
|
|
||
| == 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. |
Contributor
There was a problem hiding this 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.
|
|
||
| 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. |
Contributor
There was a problem hiding this comment.
Development occurs within personal forks, as the upstream apache/cassandra repository is strictly reserved for the trunk and official release branches.
| # there should only be one commit, squashed | ||
| git cherry-pick <jira>/<branch> | ||
| git push --atomic origin trunk -n | ||
| # check dry-run looks correct |
Contributor
There was a problem hiding this 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
| ---- | ||
| git switch trunk | ||
| # there should only be one commit, squashed | ||
| git cherry-pick <jira>/<branch> |
Contributor
There was a problem hiding this comment.
cherry pick a branch or commit-hash?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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_commitdocumentation 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 Committerssection tohow_to_commit.adocwhich covers:remote add,rebase -i,commit --amend,push --atomic -n).