From 7a341ca957567d664e44a82a982d3464eac932d0 Mon Sep 17 00:00:00 2001 From: Rajarshee Chatterjee Date: Tue, 1 Sep 2026 19:21:23 +0530 Subject: [PATCH] docs: add commit message conventions (#2489) Co-authored-by: Claude --- .github/pull_request_template.md | 1 + AGENTS.md | 16 ++++++++++++++++ 2 files changed, 17 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 7905262..7e50b26 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -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(): add new source`) diff --git a/AGENTS.md b/AGENTS.md index e79ae3e..ff7ad1a 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -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. ``, `/` +- Lowercase type, imperative mood ("add" not "added"/"adds") + +Examples: +- feat(): add new source +- fix(/): 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.