Skip to content

CASSANDRA-19777: Update doc page for how-to commit with more intro#311

Open
arvindKandpal-ksolves wants to merge 8 commits intoapache:trunkfrom
arvindKandpal-ksolves:CASSANDRA-19777
Open

CASSANDRA-19777: Update doc page for how-to commit with more intro#311
arvindKandpal-ksolves wants to merge 8 commits intoapache:trunkfrom
arvindKandpal-ksolves:CASSANDRA-19777

Conversation

@arvindKandpal-ksolves
Copy link
Contributor

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.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

patch by Arvind Kandpal; for CASSANDRA-19777
@arvindKandpal-ksolves
Copy link
Contributor Author

Hi @bschoening , I have applied Copilot suggestions , Please take a look.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants