Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Git

.gitignore

Repository .gitignore files should contain only entries directly related to that repository's content, such as target/ for Rust projects or book/ for mdBook projects. User-specific entries like IDE configuration or system files like .DS_Store should be added to the user's global .gitignore (see man gitignore for more details; this file is typically located at ~/.config/git/ignore).

Creating commits

Changes to code require:

  • Traceability to change requests
  • Clear marking of breaking changes

Commit messages must follow the conventional commits specification.

Commit messages that close a Linear or Github issue should include a Closes: footer with the issue identifier. If the commit is related to the issue but does not close it, then use a Refs: footer instead.

For example:

feat: add foobar

Also changed baz.

Closes: DEV-123