docs: add commit message conventions (#2489)

Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
Rajarshee Chatterjee
2026-09-01 19:21:23 +05:30
committed by GitHub
parent a70f9ad4a7
commit 7a341ca957
2 changed files with 17 additions and 0 deletions
+1
View File
@@ -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
View File
@@ -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.