CASSANDRA-19777: Update doc page for how-to commit with more intro#311
Closed
arvindKandpal-ksolves wants to merge 1 commit intoapache:trunkfrom
Closed
CASSANDRA-19777: Update doc page for how-to commit with more intro#311arvindKandpal-ksolves wants to merge 1 commit intoapache:trunkfrom
arvindKandpal-ksolves wants to merge 1 commit 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.
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. |
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
bschoening
requested changes
Apr 3, 2026
bschoening
requested changes
Apr 6, 2026
arvindKandpal-ksolves
force-pushed
the
CASSANDRA-19777
branch
from
3ffa2e0 to
cf49da2
Compare
bschoening
approved these changes
Apr 8, 2026
Member
|
@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 ? |
Added an introduction to the how_to_commit documentation to outline Git workflow prerequisites, preferred tooling, and feature branch rules. patch by Arvind Kandpal; reviewed by Michael Semb Wever and Brandon Schoening for CASSANDRA-19777
arvindKandpal-ksolves
force-pushed
the
CASSANDRA-19777
branch
from
cf49da2 to
8020d0e
Compare
Member
|
Committed with 732d439 |
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).