Skip to content

Commit 7f44cfa

Browse files
authored
docs: simplify PR AI checklist and rename AI policy file (#3470)
## Why? ## What does this PR do? ## Related issues ## AI Contribution Checklist (required when AI assistance = `yes`) - [ ] Substantial AI assistance was used in this PR: `yes` / `no` - [ ] If `yes`, I included the standardized AI Usage Disclosure block below. - [ ] If `yes`, I can explain and defend all important changes without AI help. - [ ] If `yes`, I reviewed AI-assisted code changes line by line before submission. - [ ] If `yes`, I ran adequate human verification and recorded evidence (checks run locally or in CI, pass/fail summary, and confirmation I reviewed results). - [ ] If `yes`, I added/updated tests and specs where required. - [ ] If `yes`, I validated protocol/performance impacts with evidence when applicable. - [ ] If `yes`, I verified licensing and provenance compliance. AI Usage Disclosure (only when substantial AI assistance = `yes`): ```text AI Usage Disclosure - substantial_ai_assistance: yes - scope: <design drafting | code drafting | refactor suggestions | tests | docs | other> - affected_files_or_subsystems: <high-level paths/modules> - human_verification: <checks run locally or in CI + pass/fail summary + contributor reviewed results> - performance_verification: <N/A or benchmark/regression evidence summary> - provenance_license_confirmation: <Apache-2.0-compatible provenance confirmed; no incompatible third-party code introduced> ``` ## Does this PR introduce any user-facing change? - [ ] Does this PR introduce any public API change? - [ ] Does this PR introduce any binary protocol compatibility change? ## Benchmark
1 parent 3100df2 commit 7f44cfa

File tree

3 files changed

+31
-35
lines changed

3 files changed

+31
-35
lines changed

.github/pull_request_template.md

Lines changed: 6 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -28,35 +28,15 @@ Is there any related issue? If this PR closes them you say say fix/closes:
2828
- Fixes #xxxx2
2929
-->
3030

31-
## AI Contribution Checklist (required when AI assistance = `yes`)
31+
## AI Contribution Checklist
3232

33-
<!-- Please read: https://github.com/apache/fory/blob/main/AI_CONTRIBUTION_POLICY.md -->
34-
<!-- Mark `yes` when AI materially influenced technical content.
35-
Examples: non-trivial code/test logic generated by AI (even one function), about 20+ added/changed lines influenced by AI, or AI influence on API/protocol/performance/architecture decisions.
36-
Mark `no` for minor/narrow assistance only (spelling/grammar/formatting/trivial comment or wording edits with no behavior impact). -->
33+
<!-- Full requirements and disclosure template:
34+
https://github.com/apache/fory/blob/main/AI_POLICY.md#9-contributor-checklist-for-ai-assisted-prs -->
3735

3836
- [ ] Substantial AI assistance was used in this PR: `yes` / `no`
39-
- [ ] If `yes`, I included the standardized AI Usage Disclosure block below.
40-
- [ ] If `yes`, I can explain and defend all important changes without AI help.
41-
- [ ] If `yes`, I reviewed AI-assisted code changes line by line before submission.
42-
- [ ] If `yes`, I ran adequate human verification and recorded evidence (checks run locally or in CI, pass/fail summary, and confirmation I reviewed results).
43-
- [ ] If `yes`, I added/updated tests and specs where required.
44-
- [ ] If `yes`, I validated protocol/performance impacts with evidence when applicable.
45-
- [ ] If `yes`, I verified licensing and provenance compliance.
46-
47-
AI Usage Disclosure (only when substantial AI assistance = `yes`):
48-
49-
<!-- Use this standard template to keep reviews consistent and low-overhead. -->
50-
51-
```text
52-
AI Usage Disclosure
53-
- substantial_ai_assistance: yes
54-
- scope: <design drafting | code drafting | refactor suggestions | tests | docs | other>
55-
- affected_files_or_subsystems: <high-level paths/modules>
56-
- human_verification: <checks run locally or in CI + pass/fail summary + contributor reviewed results>
57-
- performance_verification: <N/A or benchmark/regression evidence summary>
58-
- provenance_license_confirmation: <Apache-2.0-compatible provenance confirmed; no incompatible third-party code introduced>
59-
```
37+
- [ ] If `yes`, I included a completed [AI Contribution Checklist](https://github.com/apache/fory/blob/main/AI_POLICY.md#9-contributor-checklist-for-ai-assisted-prs) in this PR description and the required `AI Usage Disclosure`.
38+
39+
<!-- If substantial AI assistance = `yes`, paste the completed checklist and disclosure block here. -->
6040

6141
## Does this PR introduce any user-facing change?
6242

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ The key words MUST, MUST NOT, REQUIRED, SHOULD, and MAY are interpreted as descr
1818

1919
For substantial AI assistance, PR descriptions MUST include a short `AI Usage Disclosure` section.
2020
For minor or narrow AI assistance, full disclosure is not required.
21+
The PR template keeps this section intentionally short and links to Section 9 for the complete checklist.
2122

2223
Definition of substantial AI assistance:
2324

@@ -144,13 +145,28 @@ Any long-term contribution restrictions MUST follow Apache project governance an
144145

145146
## 9. Contributor Checklist (for AI-Assisted PRs)
146147

147-
- [ ] I can explain and defend all important changes.
148-
- [ ] I reviewed AI-assisted code line by line before submission.
149-
- [ ] I provided `AI Usage Disclosure` without exposing private/internal details.
150-
- [ ] I ran relevant local build/lint/test checks and reported outcomes.
151-
- [ ] I added/updated tests and specs where required.
152-
- [ ] I validated protocol/performance impacts with evidence when applicable.
153-
- [ ] I verified licensing and provenance compliance.
148+
This is the canonical checklist for the PR template AI section.
149+
150+
- [ ] Substantial AI assistance was used in this PR: `yes` / `no`
151+
- [ ] If `yes`, I included the standardized `AI Usage Disclosure` block below.
152+
- [ ] If `yes`, I can explain and defend all important changes without AI help.
153+
- [ ] If `yes`, I reviewed AI-assisted code changes line by line before submission.
154+
- [ ] If `yes`, I ran adequate human verification and recorded evidence (checks run locally or in CI, pass/fail summary, and confirmation I reviewed results).
155+
- [ ] If `yes`, I added/updated tests and specs where required.
156+
- [ ] If `yes`, I validated protocol/performance impacts with evidence when applicable.
157+
- [ ] If `yes`, I verified licensing and provenance compliance.
158+
159+
AI Usage Disclosure (only when substantial AI assistance = `yes`):
160+
161+
```text
162+
AI Usage Disclosure
163+
- substantial_ai_assistance: yes
164+
- scope: <design drafting | code drafting | refactor suggestions | tests | docs | other>
165+
- affected_files_or_subsystems: <high-level paths/modules>
166+
- human_verification: <checks run locally or in CI + pass/fail summary + contributor reviewed results>
167+
- performance_verification: <N/A or benchmark/regression evidence summary>
168+
- provenance_license_confirmation: <Apache-2.0-compatible provenance confirmed; no incompatible third-party code introduced>
169+
```
154170

155171
## 10. Governance Note
156172

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ For more details, please check [pr-lint.yml](./.github/workflows/pr-lint.yml).
2727

2828
## AI-assisted contributions
2929

30-
For full requirements, see [AI Contribution Policy](./AI_CONTRIBUTION_POLICY.md).
30+
For full requirements, see [AI Contribution Policy](./AI_POLICY.md).
3131

3232
Key points:
3333

3434
- AI tools are allowed as assistants, but contributors remain fully responsible for all submitted changes.
3535
- AI-assisted code must be reviewed carefully line by line before submission, and contributors must be able to explain and defend it during review.
36-
- For substantial AI assistance, provide privacy-safe disclosure in the PR using the standard template in `.github/pull_request_template.md`. Minor/narrow AI assistance does not require full disclosure.
36+
- For substantial AI assistance, provide privacy-safe disclosure in the PR using the [AI Contribution Checklist](./AI_POLICY.md#9-contributor-checklist-for-ai-assisted-prs) template. Minor/narrow AI assistance does not require full disclosure.
3737
- Include adequate human verification evidence (for example exact build/lint/test commands and pass/fail outcomes), and add/update tests and specs where required.
3838
- For protocol/type-mapping/wire-format or performance-sensitive changes, provide the required compatibility/performance validation evidence.
3939
- Ensure licensing and provenance compliance with [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) and do not submit content with uncertain provenance.

0 commit comments

Comments
 (0)