Committing changes to Git

<!> Totally incomplete, but we have to start somewhere. Please contribute! <!>

<!> UNDER CONSTRUCTION, INSTRUCTIONS ARE NOT COMPLETE OR EVEN GUARANTEED TO WORK <!>

Disclaimer Currently, we're still working out the preferred way of committing to Git, so this page is definitely a "work in progress". If you're a seasoned Git pro do not feel that what's written here is a requirement, but do please look it over and see if it's reasonably compatible.

There's been a lot of discussion about how to commit to the Git repo since we moved to using Git in early 2016. This page is intended for people new to Git or Lucene/Solr as a place to start. If you're totally new to Git or if you're a new committer, this should get you started.

NOTES:

There are about a zillion "how to use Git" links out there, here are a few links that are useful in this context. Except for Dawid's and Apache's pages, these are not associated with this project.

The goal here is to provide a super-simple guide without getting off into the all the possibilities, and it will certainly seem "too simple" to sophisticated users. We all have to start somewhere.

Git defaults

Here are some recommended defaults to configure Globally for Git:

git config [--global] user.name <real-name>
git config [--global] user.email <email>@apache.org

#Is this really recommended?
git config --global pull.rebase true

Simple commits

For simple commits for simple JIRAs for simple people, here are a few ways of going about it.

method 1

update your repo (perhaps with .gitconfig making this use rebasing)

Notes:

method 2

<!> Anyone want to volunteer to add something here? <!>

Backporting changes from trunk to 5x (6x sometime soon)

The usual recommendation is to "cherry pick".

<!> There has been some issue with Solr's CHANGES.txt file "cherry picking" all of the changes for trunk, so check this file especially <!>

Add patches to JIRA tickets or not?

<!> what is the consensus here? <!>

More sophisticated options for more sophisticated people

<!> Hey, Git Pros! Feel free to add information here. <!>

IntelliJ notes

Git commit process (last edited 2016-02-08 01:22:29 by ErickErickson)