FlightGear Git: gitiquette

From FlightGear wiki
Jump to: navigation, search

Git is the main version control system used by the FlightGear project. In order to keep the repositories clean and well structured, commiters are requested to adhere to the gitiquette.

  • Make sure all material is GPL-compatible and released as such.
  • Rebase your repository before pushing. This prevents local merges from ending up in the repository. The fact that you merged your local branch with the development stream is of no interest to other developers and makes it particularly hard to understand the history of commits. If you have uncommited changes in your local directory, you can temporarily stash them, so git rebase will not complain:
git stash
git pull --rebase origin/master
git stash pop
  • Compose a clear and concise log message to describe those changes and the reasons for them.
  • Check git history before pushing. This allows you to read and double check your own changes a final time - and also check the history for local merge or funny duplication issues. The command is:
gitk
  • to interactively rewrite/rebase the history and squash commits, use git rebase -i
  • Use your own (real) name. You can set your git username with the following command:
git config --global user.name "Isaac Newton"
  • Not all OS distinct capitals (eg. Switch.ac and switch.ac is seen as a single file on Windows) and not all OS can handle spaces. So always use unique file and directory names, without spaces.

The "in case of doubt ask" policy holds for all listed points. You can contact some of FlightGear's git experts on the devel-mailing list or the IRC channel.

Related content