A CI/CD tool for enforcing helpful file-specific descriptions in GitHub Pull Requests.
Breadcrumbs enforces an opinionated standard for PR descriptions that requires developers to document their changes on a per-file basis. This helps reviewers understand changes more easily and improves code review efficiency.
Breadcrumbs checks your PR description for properly formatted file annotations:
[path/to/file.js]
<L 10-15> Description of what changed in these lines
[another/file.tsx]
<*> Description of changes across the entire file
- File paths must be enclosed in square brackets:
[path/to/file.js] - Line annotations must be enclosed in angle brackets:
<L 10-15>or<*>for all lines - Each file modified in the PR must have a corresponding entry in the description
- Specific line numbers are encouraged but
<*>is acceptable
[components/Nav.tsx]
<L 22-26> Simplified logic for active link highlighting
[lib/hooks/useAuth.ts]
<*> Fixed edge case with expired tokens
[*]
Styling changes across multiple files
- Strict Mode: Every modified file must have a specific entry
- Loose Mode: Allows use of wildcards
[*]to cover multiple files
- Add the GitHub workflow to your repository
- Configure mode in the workflow file
- Start using the format in your PRs!
MIT