[
https://issues.apache.org/jira/browse/CASSANDRA-19777?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Brad Schoening updated CASSANDRA-19777:
---------------------------------------
Change Category: Operability
Complexity: Low Hanging Fruit
Component/s: Documentation/Website
Priority: Low (was: Normal)
Status: Open (was: Triage Needed)
> Update doc page for how-to commit with more intro
> -------------------------------------------------
>
> Key: CASSANDRA-19777
> URL: https://issues.apache.org/jira/browse/CASSANDRA-19777
> Project: Apache Cassandra
> Issue Type: Task
> Components: Documentation/Website
> Reporter: Brad Schoening
> Priority: Low
>
> The
> [how_to_commit|https://github.com/apache/cassandra-website/blob/trunk/site-content/source/modules/ROOT/pages/development/how_to_commit.adoc]
> documentation would be more helpful to new committers with some background
> details on the below. This should not be a git tutorial, but it should inform
> readers what they need to know or learn to be an effective committer.
> 0a) Using CLI vs GitHub web UI
> 0b) Always do your work in a local branch, and never push a branch upsteam.
> 1) The squash-rebase-merge (best name?) workflow with feature branches used
> on this repo
> 2) Basic git commands you should know, including:
> * *git remote* add & set-url
> * *squashing* with rebase -i
> * updating commit with *git commit --amend*
> * *push upstream <repo> --atomic -n*
> github.com offers these CLI commands for merging a PR:
> {noformat}
> Step 1 From your project repository, check out a new branch and test the
> changes.
> 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.
> git checkout trunk
> git merge --no-ff omniCoder77-feature/guardrail-for-misprepare-statements
> git push origin trunk
> {noformat}
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
