Skip to content

docs: add commit message conventions #2489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rajarsheechatterjee merged 3 commits into from
Sep 1, 2026
Merged

docs: add commit message conventions #2489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d090771
docs: add commit message conventions
claude Sep 1, 2026
afd630f
docs: use generic placeholders in commit convention examples
claude Sep 1, 2026
5c294a5
docs: note AI agent attribution in commit conventions
claude Sep 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
- [ ] Update version code if an existing plugin was modified
- [ ] Test changes in Plugin Playground or the app
- [ ] Reference related issues in the PR body (e.g. Closes #xyz)
- [ ] Commit messages follow `type(scope): description` (e.g. `feat(<generator>): add new source`)
16 changes: 16 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,3 +128,19 @@ works because target-site markup and network defenses change independently of th
`Closes #123`).
- Before handing off an existing-plugin change, confirm that its version was incremented and report
any live checks that were inconclusive because of network or anti-bot behavior.

## Commit messages

Use Conventional Commits: `type(scope): description`

- type: feat (new plugin), fix (bug fix), perf, chore, docs, refactor
- scope: language/plugin folder, e.g. `<language>`, `<language>/<plugin>`
- Lowercase type, imperative mood ("add" not "added"/"adds")

Examples:
- feat(<generator>): add new source
- fix(<language>/<plugin>): correct chapter list parsing

If a commit or PR was authored (fully or partly) by an AI agent, note that in the commit message
(e.g. a `Co-Authored-By:` trailer) or the PR description so reviewers know to weight their review
accordingly.
Loading