What problem does it solve?
Git notes provide a way to attach metadata to commits and other Git objects after they are created, enabling teams to record review status, test results, audit information, and contextual annotations without rewriting history or changing object SHAs.
Core Features & Use Cases
- Non-invasive annotations: Add, append, edit, and remove notes without amending commits or altering commit hashes.
- Namespaced organization: Use separate notes refs for reviews, testing, and audits to keep annotations scoped and discoverable.
- Sharing and preservation: Push and fetch refs/notes/* to share notes across remotes and configure rewrite settings to preserve notes during rebase and amend operations.
- Workflows: Track code review approvals, record CI test outcomes, maintain audit trails, and perform bulk operations to annotate multiple commits by author or range.
Quick Start
Add a review note to a specific commit in the reviews namespace and push the notes ref to the remote.