From add540f5ae46755fd06f3317383fa122938a88c6 Mon Sep 17 00:00:00 2001 From: Minseok Kim Date: Sat, 25 Apr 2026 21:40:03 +0900 Subject: [PATCH] Add AI-Assisted Pull Requests policy and PR template field Codify how AI tools may participate in contributions: disclose use, name the tool and model, keep human discussion human, and run a self-review pass before opening the PR. The matching field in the PR template makes the disclosure structured rather than left to convention. Inspired by SlateDB's contribution policy. --- .github/PULL_REQUEST_TEMPLATE.md | 5 +++++ CONTRIBUTING.md | 18 ++++++++++++++++++ 2 files changed, 23 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 75466282..61a441b3 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -11,3 +11,8 @@ Closes # ## How to Test +## AI Assistance + +- [ ] This PR was written largely with AI assistance. + - Tool / model: + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3a327b28..ce9cc06a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -83,6 +83,24 @@ git remote add origin https://github.com/YOUR_USERNAME/actionbase.git 5. Commit: `git commit -m "feat(scope): description"` 6. Push & create PR +## AI-Assisted Pull Requests + +AI-assisted pull requests are welcome, provided that you: + +- Note in the PR description if the changes were largely written by AI. +- Name the AI tool and model that produced them (e.g., Claude Code, Cursor, + Codex, ChatGPT). +- Understand the changes — be ready to discuss any line. +- Write the PR description and reply to reviewers in your own voice. Do not + paste AI-generated text into review threads. +- Read through the diff yourself before opening the PR. +- Run a code-review pass with your AI tool (e.g., `/review` in Claude Code + or Codex CLI) before submitting. +- Follow the conventions in [`CODING_STYLE.md`](CODING_STYLE.md) and the + test rules in [`TESTING.md`](TESTING.md). + +_Inspired by [SlateDB's contribution policy](https://github.com/slatedb/slatedb/blob/main/CONTRIBUTING.md) — thanks to the SlateDB team for codifying these norms._ + ## Translations Translations are managed through Translation Memory (TM) files. Here's how to contribute: