Moving the readme and making it a project-wide overview.
[git-central.git] / README.markdown
1
2 Overview
3 ========
4
5 Tweaks for using git in a corporate/close-team environment.
6
7 Server-side Hooks
8 =================
9
10 See the individual scripts for documentation, but an overview:
11
12 * post-receive-assign-commitnumbers: makes Subversion-like monotonically increasing commit numbers for every commit
13 * post-receive-email: contrib email script with customizations for stuff like combined diffs
14 * post-receive-git-config: auto-updates the git config+hooks on the server when updated in the repo
15 * post-receive-hudson: auto-creates new jobs in Hudson when branches in git are created
16 * post-receive-trac: updates trac tickets with messages referencing the commits
17 * update-allow-tags-branches: contrib/example branch/tag enforcement script with customizations
18 * update-ensure-follows: allows nomination of special branches (e.g. stable) that everyone must have merged
19 * update-ensure-ticket-reference: enforces ticket references in commit messages (e.g. for trac)
20 * update-lock-check: enforces locked/preserved branches
21 * update-stable: enforces proper movement of stable
22
23 Client-side Hooks
24 =================
25
26 * commit-msg-trac: enforces ticket references in commit messages
27
28 Scripts
29 =======
30
31 * checkout: `checkout <branch>` does the right thing for creating/tracking a new or existing remote branch
32 * push: pushes only the current branch to origin
33 * pull: pulls changes down but with rebase-i-p (instead of merge) to avoid same-branch merges and commit replays
34