Skip to content

Commit f4d436a

Browse files
kmishra1204kmishra1204
committed
Add adopter guide and review template
1 parent a75de83 commit f4d436a

7 files changed

Lines changed: 222 additions & 3 deletions

File tree

‎.github/ISSUE_TEMPLATE/adoption_review.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Adoption review
3+
about: Try the Agentic Enterprise Readiness Profile in another repository.
4+
title: "Adoption review: "
5+
labels: "feedback-wanted, profile"
6+
assignees: ""
7+
---
8+
9+
## Repository
10+
11+
Link to the repository or branch being reviewed.
12+
13+
## Repository Type
14+
15+
- [ ] Agentic application
16+
- [ ] MCP server or client
17+
- [ ] Coding agent
18+
- [ ] Workflow agent
19+
- [ ] Support or knowledge agent
20+
- [ ] Identity, policy, or governance tool
21+
- [ ] Other:
22+
23+
## Evidence Added
24+
25+
- [ ] `AGENTS.md`
26+
- [ ] `docs/AGENTIC_BOUNDARY_MODEL.md`
27+
- [ ] `agentic-readiness.json`
28+
- [ ] validation command or proof path
29+
- [ ] OSS/self-hosted fallback notes
30+
31+
## Requested Review
32+
33+
What kind of feedback do you want?
34+
35+
- [ ] profile level scoring
36+
- [ ] boundary model clarity
37+
- [ ] approval gates
38+
- [ ] audit event model
39+
- [ ] schema shape
40+
- [ ] missing evidence
41+
42+
## Anti-Claim Check
43+
44+
- [ ] This does not claim AAIF or Linux Foundation endorsement.
45+
- [ ] This does not claim production readiness without runtime evidence.
46+
- [ ] This does not claim adoption outside the linked public evidence.

‎PROFILE.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,10 @@ Template:
102102

103103
- [templates/AGENTIC_BOUNDARY_MODEL.md](templates/AGENTIC_BOUNDARY_MODEL.md)
104104

105+
Adoption:
106+
107+
- [docs/ADOPTER_GUIDE.md](docs/ADOPTER_GUIDE.md)
108+
105109
Scoring:
106110

107111
- [docs/SCORING_GUIDE.md](docs/SCORING_GUIDE.md)

‎README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ At minimum:
4444

4545
Use these starter artifacts:
4646

47+
- [Adopter guide](docs/ADOPTER_GUIDE.md)
4748
- [Boundary model template](templates/AGENTIC_BOUNDARY_MODEL.md)
4849
- [Scoring guide](docs/SCORING_GUIDE.md)
4950
- [Ecosystem alignment brief](docs/ECOSYSTEM_ALIGNMENT_BRIEF.md)
@@ -89,8 +90,8 @@ Bad use:
8990

9091
## Current Status
9192

92-
Version: `0.2.1`
93+
Version: `0.2.2`
9394

94-
Status: early OSS profile with public flagship examples, boundary template, scoring guide, and ecosystem alignment brief.
95+
Status: early OSS profile with public flagship examples, adopter guide, boundary template, scoring guide, and ecosystem alignment brief.
9596

9697
Next target: external technical feedback from agentic AI maintainers and AAIF/LF-style community forums.

‎ROADMAP.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
## 0.3.0
1919

20+
- Add first external adoption example if a maintainer opts in.
2021
- Expand ecosystem-alignment examples across AGENTS.md, MCP, and agent gateway governance.
2122
- Add compatibility policy.
2223
- Add CI badge and release notes.

‎docs/ADOPTER_GUIDE.md‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
# Adopter Guide
2+
3+
## Purpose
4+
5+
This guide helps maintainers try the Agentic Enterprise Readiness Profile in their own repository without adopting the whole framework at once.
6+
7+
The profile is not a certification. It is a way to expose evidence for agentic AI repositories that need clearer review around agent instructions, tool/action boundaries, human approval, identity, auditability, OSS fallbacks, and validation.
8+
9+
## Minimal Adoption Path
10+
11+
Start with three files:
12+
13+
1. `AGENTS.md`
14+
2. `docs/AGENTIC_BOUNDARY_MODEL.md`
15+
3. `agentic-readiness.json`
16+
17+
Then add these as the repository matures:
18+
19+
- `CONTRIBUTING.md`
20+
- `SECURITY.md`
21+
- `GOVERNANCE.md`
22+
- `ROADMAP.md`
23+
- validation evidence
24+
- threat model
25+
- observability or audit model
26+
- OSS/self-hosted fallback notes
27+
28+
## Step 1: Add AGENTS.md
29+
30+
Document how AI coding agents and human contributors should work in the repository.
31+
32+
Include:
33+
34+
- safe edit boundaries
35+
- validation commands
36+
- secret-safety rules
37+
- human review expectations
38+
- AI assistance disclosure expectations
39+
40+
## Step 2: Add Boundary Model
41+
42+
Copy:
43+
44+
- `templates/AGENTIC_BOUNDARY_MODEL.md`
45+
46+
Fill in:
47+
48+
- high-risk action boundary
49+
- actors
50+
- identity boundary
51+
- tool/action boundary
52+
- human approval gates
53+
- audit events
54+
- local proof path
55+
- OSS/self-hosted fallbacks
56+
57+
## Step 3: Add agentic-readiness.json
58+
59+
Use the schema:
60+
61+
- `schema/agentic-readiness.schema.json`
62+
63+
Minimal example:
64+
65+
```json
66+
{
67+
"schema": "https://github.com/kmishra1204/agentic-enterprise-readiness-profile/schema/agentic-readiness.schema.json",
68+
"generatedAt": "2026-07-05T00:00:00Z",
69+
"maintainer": "Example Maintainer",
70+
"repository": "https://github.com/example/repo",
71+
"product": "Example Agentic Repository",
72+
"domain": "Agentic workflow or tool governance",
73+
"independentStatus": "Independent project; no endorsement claimed.",
74+
"profileLevel": 2,
75+
"profileLevelMeaning": "Agentic readiness evidence started",
76+
"readinessScore": {
77+
"score": 8,
78+
"max": 15
79+
},
80+
"flagship": false,
81+
"aaifAdjacentThemes": [
82+
"AGENTS.md",
83+
"MCP-style tool boundaries",
84+
"human approval",
85+
"audit events"
86+
],
87+
"publicContributionTheme": "Document and validate agent/tool boundaries.",
88+
"validationCommands": {
89+
"test": "npm test"
90+
},
91+
"evidence": {
92+
"README.md": true,
93+
"AGENTS.md": true,
94+
"docs/AGENTIC_BOUNDARY_MODEL.md": true
95+
}
96+
}
97+
```
98+
99+
## Step 4: Score Conservatively
100+
101+
Use:
102+
103+
- `docs/SCORING_GUIDE.md`
104+
105+
Rules:
106+
107+
- Score only public evidence.
108+
- Treat missing evidence as incomplete.
109+
- Treat blocked runtime proof as a blocker, not a pass.
110+
- Do not claim production readiness from documentation alone.
111+
- Do not claim AAIF/Linux Foundation affiliation from profile adoption.
112+
113+
## Step 5: Ask For Review
114+
115+
Open a public issue using:
116+
117+
- `.github/ISSUE_TEMPLATE/adoption_review.md`
118+
119+
Ask reviewers:
120+
121+
- Are the action boundaries clear?
122+
- Are approval gates realistic?
123+
- Are audit events useful?
124+
- Are OSS fallbacks practical?
125+
- Is the profile level too high, too low, or justified?
126+
127+
## Good Candidate Repositories
128+
129+
The profile is most useful for repositories that include:
130+
131+
- agents that call tools
132+
- MCP servers or clients
133+
- coding agents
134+
- workflow agents
135+
- support or knowledge agents
136+
- identity or policy agents
137+
- sandboxed execution
138+
- human approval loops
139+
- production-readiness claims
140+
141+
## Poor Candidate Repositories
142+
143+
The profile is likely too heavy for:
144+
145+
- tiny demos
146+
- pure libraries with no agent/tool boundary
147+
- private/internal-only projects
148+
- projects that cannot expose any evidence publicly
149+
150+
## Anti-Claims
151+
152+
Adopting the profile does not mean:
153+
154+
- production-ready
155+
- enterprise-certified
156+
- AAIF project
157+
- Linux Foundation project
158+
- endorsed by any foundation
159+
- externally adopted without proof
160+
161+
## Feedback
162+
163+
Share feedback here:
164+
165+
- https://github.com/kmishra1204/agentic-enterprise-readiness-profile/discussions/3

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "agentic-enterprise-readiness-profile",
3-
"version": "0.2.1",
3+
"version": "0.2.2",
44
"private": false,
55
"type": "module",
66
"description": "Evidence-first readiness profile for agentic AI repositories.",

‎scripts/validate-readiness.mjs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@ const examplesDir = path.join(root, "examples");
66
const requiredDocs = [
77
"README.md",
88
"PROFILE.md",
9+
"docs/ADOPTER_GUIDE.md",
910
"docs/ECOSYSTEM_ALIGNMENT_BRIEF.md",
1011
"docs/SCORING_GUIDE.md",
12+
".github/ISSUE_TEMPLATE/adoption_review.md",
1113
"templates/AGENTIC_BOUNDARY_MODEL.md",
1214
"schema/agentic-readiness.schema.json"
1315
];

0 commit comments

Comments
 (0)