Hacking-Git.md

layout	title
default	Hacking Git

The goal of this document is not to be a tutorial, but rather to point to interesting material that has already been written.

The goal is also not to list all the articles about Git or its internals. There are a lot of good resources, including free books, about that elsewhere.

Contributions are welcome though! Please contact us on the Git Mailing list (at [email protected]) or open an issue or a pull request on our GitHub repo to discuss or suggest improvements. Thanks!

Building Git

• "INSTALL"

• "Installing from Source" in the Pro Git book

• The top of the Makefile, for special "Makefile knobs"

Understanding the Git code base

• "A birds-eye view of Git’s source code" in the Git User’s Manual

• Fabien Sanglar's Git Source Code Review

• Boost Your Programming Skills by Reading Git's Code

Getting started hacking and contributing

• "My First Contribution"

• "My First Object Walk"

• Matheus' tutorial

• "Hacking Git" in the Git User's Manual

• "Documentation/technical", technical documentation (also viewable at https://git-scm.com/docs/<file-name-without-.txt>)

• Our General Microproject Information can help understand the process of contributing and find issues to work on.

Conventions and processes

• "CodingGuidelines"

• "SubmittingPatches"

• Git for Windows' "Good commits"

Development status

• Junio's "What's cooking in git.git" emails list the status of various development topics.

• Git's release calendar shows the planned release cycles, and the maintainer's planned offline time.

Branching workflow

• "A note from the maintainer"

• "Large-Merging Workflows" in the Pro Git book

• gitworkflows manual page

• "How to maintain Git"

• "How the Creators of Git do Branching", and the associated gitworkflow repository

Debugging

• Git for Windows' Debugging Git

• Launching GDB explanations in CodingGuidelines

• Philippe Blain's "Debugging Git" Gist

Tests

• "t/README"

• "t/perf/README"

Community, getting help, mentoring

• git-scm community page

• web interface to #git-devel IRC channel on Libera Chat

• #git-devel IRC channel archive

• git-mentoring mailing list

Mentoring programs

• Google Summer of Code

• Outreachy

• General Application Information