michaelsembwever commented on code in PR #4327: URL: https://github.com/apache/cassandra/pull/4327#discussion_r2300037563
########## CONTRIBUTING.md: ########## @@ -18,16 +18,39 @@ # --> -# Apache Cassandra and Pull Requests +# How to Contribute -Apache Cassandra doesn't use GitHub pull requests as part of the development process. -In fact, this repository is a GitHub mirror of [the official repo](https://gitbox.apache.org/repos/asf/cassandra.git). +There are many opportunities to contribute code to Apache Cassandra, including documentation updates, test improvements, +bug fixes, changes to the Java code base, and tooling improvements. -# How to Contribute +A recommended workflow to get started is: +1. Find or create an issue in the [Cassandra JIRA](https://issues.apache.org/jira/browse/CASSANDRA/) that describes the work you plan to do. +2. Create a personal fork of the [Apache Cassandra GitHub repo](https://github.com/apache/cassandra). +3. Clone your fork into your development environment. +4. Create your feature branch. Suggestion: name your branch with the related JIRA id: e.g. CASSANDRA-12345 . Review Comment: the reasoning for the `your-name/` prefix is it helps teams work together (e.g. when needing to rebase dev branches). it's also nice to see branches in a shared fork sorted first by owner (and makes cleaning up old stale branches easier). the reasoning for the `/base-branch` suffix is when patches differ across baselines and need separate branches. we still want these categorised by owner and then ticket. -- another time, `build/sh/development-switch.sh` could be improved. it's `--jira` flag could be renamed to `--branch` (as it has actually nothing to do with a jira, just the branch name). (e.g. you don't have to first have a jira to create a dev branch) -- 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: pr-unsubscr...@cassandra.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: pr-unsubscr...@cassandra.apache.org For additional commands, e-mail: pr-h...@cassandra.apache.org
