Skip to content

Commit 6c86202

Browse files
[DOCUMENTATION] Slight improvement to AI Usage Policy (- WIP #367 -)
Changes in file .github/AI_USAGE_POLICY.md: * new section for defining acronyms * improvements based on review (- WIP PR #415 -) * related work
1 parent a8f757d commit 6c86202

File tree

1 file changed

+27
-11
lines changed

1 file changed

+27
-11
lines changed

.github/AI_USAGE_POLICY.md

Lines changed: 27 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,26 @@
22

33
## 1. Purpose and Scope
44

5-
This policy governs the use of AI tools, particularly CodeRabbitAI, GH Copilot, and
6-
Codecov-ai-reviewer, within the Multicast project's development workflow. It establishes
7-
guidelines for responsible AI integration while maintaining the project's security, quality, and
8-
integrity.
5+
### 1.1 Rational :bookmark:
6+
7+
> [!IMPORTANT]
8+
> This policy governs the use of AI tools, particularly CodeRabbitAI, GH Copilot, and
9+
> Codecov-ai-reviewer, within the Multicast project's development workflow. It establishes
10+
> guidelines for responsible AI integration while maintaining the project's security, quality, and
11+
> integrity.
12+
13+
### 1.2 Definitions :book:
14+
15+
* 1.2.A The following acronyms and abbreviations are used throughout this document:
16+
* **AI** - Artificial Intelligence
17+
* **CEP** - Convention Enhancement Proposal
18+
* **CI** - Continuous Integration
19+
* **CWE** - Common Weakness Enumeration (security vulnerability classification system)
20+
* **e.g.** - exempli gratia (for example)
21+
* **GH** - GitHub (as used in "GH Copilot")
22+
* **GHI** - GitHub Issues
23+
* **LLM** - Large Language Model
24+
* **PR** - Pull Request
925

1026
## 2. AI Role Definitions
1127

@@ -14,7 +30,7 @@ integrity.
1430
* 2.1.A Assistive Code Review:
1531
* AI may provide feedback on code quality, style compliance, and potential issues.
1632
* 2.1.B Assistive Project-Management Delegation:
17-
* AI may provide feedback when requested on GHI (GitHub issues), as well as open new, or comment
33+
* AI may provide feedback when requested on GitHub issues (GHIs), as well as open new, or comment
1834
on existing, GHI, to track suggested improvements to the project content.
1935
* 2.1.C Documentation Improvement:
2036
* AI may suggest improvements to documentation clarity and completeness.
@@ -30,7 +46,7 @@ integrity.
3046
### 2.2 Prohibited AI Roles :no_entry_sign:
3147

3248
* 2.2.A Sole Developer:
33-
* AI (especially LLM type AI) is not well suited for innovation; No vibe-coding, the direction
49+
* AI (especially LLM bassed AI) is not well suited for innovation; No vibe-coding - the direction
3450
and development of the project CANNOT meaningfully come from AI.
3551
* 2.2.B Sole Approver:
3652
* AI approval alone is insufficient for merging any PR.
@@ -51,7 +67,7 @@ integrity.
5167
* All PRs MUST receive at least one human review from an authorized maintainer
5268
* 3.1.B Verify or Resolve
5369
* Human reviews must verify (or conversely reject) the AI's suggestions.
54-
* Discussions are encouraged in both cases, as Humans and AI alike, may later consider relevant
70+
* Discussions are encouraged in both cases, as humans and AI alike may later consider relevant
5571
project content in future reviews.
5672
* 3.1.C Very Large PRs
5773
* For PRs exceeding 99 changed files, at least two human reviews are recommended.
@@ -96,7 +112,7 @@ integrity.
96112
> > document it to make it even clearer.
97113
> ~ Steve McConnell
98114
99-
* All AI-suggested code changes must be verified by a human maintainer (see 3.1.B).
115+
* All AI-suggested code changes must be verified by a human maintainer (see § 3.1.B).
100116
* 4.1.B Signed Commits
101117
* Code signing with different keys for human vs. AI contributions is required.
102118
* 4.1.C Security Assessments
@@ -116,7 +132,7 @@ integrity.
116132
* The project implements a dual-approval system to help prevent single points of failure.
117133
* AI approvals are tracked separately from human approvals in the review process. Humans
118134
must be responsible for the actual merge of pull-requests.
119-
* Every user (e.g., AI or human) must have a distinct code-signing identity (see 4.1.B).
135+
* Every user (e.g., AI or human) must have a distinct code-signing identity (see § 4.1.B).
120136
* Only human controlled identities may merge branches, or commit to the default branch directly.
121137

122138
> [!NOTE]
@@ -133,9 +149,9 @@ integrity.
133149
* The `.coderabbit.yaml` file is the source of truth for CodeRabbitAI configuration.
134150
* 5.1.B Dependabot Configuration
135151
* The `.github/dependabot.yml` file is the source of truth for @dependabot configuration.
136-
* 5.1.C Changes
152+
* 5.1.C Configuration Updates
137153
* Changes to these configurations require PR approval from at least one core maintainer.
138-
* 5.1.D Audits
154+
* 5.1.D Configuration Audits
139155
* Regular audits of AI configuration will be conducted to ensure alignment with this policy.
140156

141157
### 5.2 Monitoring and Reporting

0 commit comments

Comments
 (0)