maedhroz commented on code in PR #2114: URL: https://github.com/apache/cassandra/pull/2114#discussion_r1107798301
########## CROSS-CUTTING-CONTRIBUTING.md: ########## @@ -0,0 +1,75 @@ +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +# Creating a development environment + +When cross cutting changes are needed, it is best to work in a personal branch, but would need to replicate this to each submodule impacted. + +``` +$ git checkout -b CASSANDRA-<number> +# Change the URL to point to your fork +$ git submodule set-url accord "[email protected]:$USER/cassandra-accord.git" +# Change the branch to your development branch +$ (branch="$(git rev-parse --abbrev-ref HEAD)"; cd accord && git checkout -b "$branch") +``` + +To better automate this a utility script exists, so can do + +``` +$ dev-support/development-switch.sh --jira CASSANDRA-<number> +``` + Review Comment: At this point in the narrative, a couple things we could do: 1.) Make it clear for readers who aren't familiar w/ submodules that any commits they make to Accord will be visible to C* immediately, and local testing will be possible. (Let's say this ends the "Local Development" section.) 2.) We could start a new section, let's call it "Remote Testing", that covers `bump-accord.sh`, which, because of the pre-commit hook, starts pushing things to remotes. (Then pushing the C* bits makes remote testing on Circle or wherever possible, etc.) -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
