Skip to content

Commit c87b9b6

Browse files
laugiovlaugiov
committed
feat: add agentic development framework
This major update transforms the repository into a complete reference for autonomous AI-driven development workflows. New structure: - core/ - Agent operating model, checkpoints, escalation rules - runtime/ - Quickstarts, prompts, quality gates, bootstrap guide - bench/ - 10 benchmark tasks with scoring system - tools/ - Validation utilities (planned) - case-studies/ - Workflow examples Key additions: - REPO_MAP.md for navigation by profile - BOOTSTRAP_NEW_PROJECT.md to apply framework to other projects - GitHub issue/PR templates with checkpoint requirements - CI workflows for docs hygiene and conformance checks - Complete prompt pack for Claude Code workflows Documentation reorganized for clarity: - Clear separation between reference specs (01-08) and agentic framework - Multiple entry points by user profile - Golden path for 15-minute onboarding
1 parent 73bb000 commit c87b9b6

57 files changed

Lines changed: 5111 additions & 87 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
name: Bug Report
2+
description: Report an error, broken link, or incorrect information
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for reporting an issue. Please provide details to help us fix it.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Description
15+
description: What is the problem?
16+
placeholder: Describe what's wrong
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: location
22+
attributes:
23+
label: Location
24+
description: Where is the problem?
25+
placeholder: |
26+
File path, line number, or URL
27+
Example: core/spec/CHECKPOINTS.md:45
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: expected
33+
attributes:
34+
label: Expected Behavior
35+
description: What should happen instead?
36+
placeholder: Describe the correct behavior
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: actual
42+
attributes:
43+
label: Actual Behavior
44+
description: What actually happens?
45+
placeholder: Describe what you observed
46+
validations:
47+
required: true
48+
49+
- type: dropdown
50+
id: type
51+
attributes:
52+
label: Bug Type
53+
options:
54+
- Broken link
55+
- Incorrect information
56+
- Typo / Grammar
57+
- Missing content
58+
- Formatting issue
59+
- Other
60+
validations:
61+
required: true
62+
63+
- type: textarea
64+
id: fix
65+
attributes:
66+
label: Suggested Fix
67+
description: If you know how to fix it, please describe
68+
placeholder: Optional - describe the solution
69+
validations:
70+
required: false
71+
72+
- type: checkboxes
73+
id: checklist
74+
attributes:
75+
label: Pre-submission Checklist
76+
options:
77+
- label: I have searched existing issues to avoid duplicates
78+
required: true

‎.github/ISSUE_TEMPLATE/feature.yml‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: Feature Request
2+
description: Propose a new feature or enhancement
3+
title: "[Feature]: "
4+
labels: ["enhancement", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for suggesting a feature. Please provide as much detail as possible.
10+
11+
- type: textarea
12+
id: summary
13+
attributes:
14+
label: Summary
15+
description: Brief description of the feature
16+
placeholder: What do you want to add or improve?
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: motivation
22+
attributes:
23+
label: Motivation
24+
description: Why is this feature needed? What problem does it solve?
25+
placeholder: Explain the use case and benefits
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: proposal
31+
attributes:
32+
label: Proposed Solution
33+
description: How should this feature work?
34+
placeholder: Describe the expected behavior
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: alternatives
40+
attributes:
41+
label: Alternatives Considered
42+
description: What other approaches did you consider?
43+
placeholder: List any alternatives and why they were not chosen
44+
validations:
45+
required: false
46+
47+
- type: dropdown
48+
id: scope
49+
attributes:
50+
label: Scope
51+
description: What area does this feature affect?
52+
options:
53+
- Documentation
54+
- Core Specification
55+
- Runtime / Prompts
56+
- Benchmark
57+
- Tooling
58+
- CI/CD
59+
- Other
60+
validations:
61+
required: true
62+
63+
- type: checkboxes
64+
id: checklist
65+
attributes:
66+
label: Pre-submission Checklist
67+
options:
68+
- label: I have searched existing issues to avoid duplicates
69+
required: true
70+
- label: This feature aligns with the project's goals
71+
required: true

‎.github/ISSUE_TEMPLATE/security.yml‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
name: Security Issue
2+
description: Report a security concern (non-sensitive only)
3+
title: "[Security]: "
4+
labels: ["security", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
**Important**: For sensitive security vulnerabilities, please email directly instead of using this public form.
10+
11+
Use this template for security-related documentation issues, best practice concerns, or non-sensitive security improvements.
12+
13+
- type: textarea
14+
id: description
15+
attributes:
16+
label: Description
17+
description: Describe the security concern
18+
placeholder: What is the security issue or improvement?
19+
validations:
20+
required: true
21+
22+
- type: dropdown
23+
id: category
24+
attributes:
25+
label: Category
26+
options:
27+
- Documentation gap (missing security guidance)
28+
- Best practice concern
29+
- Outdated security recommendation
30+
- Security check improvement
31+
- Compliance-related
32+
- Other
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: location
38+
attributes:
39+
label: Location
40+
description: Where is this relevant?
41+
placeholder: File path or section
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
id: impact
47+
attributes:
48+
label: Potential Impact
49+
description: What could happen if this is not addressed?
50+
placeholder: Describe the risk
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
id: recommendation
56+
attributes:
57+
label: Recommended Action
58+
description: How should this be fixed?
59+
placeholder: Describe the solution
60+
validations:
61+
required: true
62+
63+
- type: dropdown
64+
id: priority
65+
attributes:
66+
label: Priority
67+
options:
68+
- Low (minor improvement)
69+
- Medium (should fix soon)
70+
- High (needs prompt attention)
71+
validations:
72+
required: true
73+
74+
- type: checkboxes
75+
id: checklist
76+
attributes:
77+
label: Pre-submission Checklist
78+
options:
79+
- label: This does NOT contain sensitive vulnerability details
80+
required: true
81+
- label: I have searched existing issues to avoid duplicates
82+
required: true

‎.github/pull_request_template.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
## Summary
2+
3+
<!-- 1-3 sentences describing what this PR does -->
4+
5+
## Related Issue
6+
7+
<!-- Link to the issue this PR addresses -->
8+
Closes #
9+
10+
## Type of Change
11+
12+
- [ ] Documentation update
13+
- [ ] New feature
14+
- [ ] Bug fix
15+
- [ ] Refactoring
16+
- [ ] CI/CD change
17+
- [ ] Other:
18+
19+
## Checkpoints Completed
20+
21+
<!-- Mark completed checkpoints -->
22+
- [ ] **C0**: Comprehension & Scope — Objective understood, scope defined
23+
- [ ] **C1**: Plan & Risks — Implementation plan documented, risks identified
24+
- [ ] **C2**: Implementation & Tests — Changes complete, validation passing
25+
- [ ] **C3**: PR & Proofs — This PR with all required sections
26+
27+
## Changes Made
28+
29+
<!-- List files modified/created -->
30+
| File | Change |
31+
|------|--------|
32+
| `path/to/file` | Description |
33+
34+
## Testing / Validation
35+
36+
<!-- What tests or checks were run? -->
37+
- [ ] Link validation passed
38+
- [ ] Markdown lint passed
39+
- [ ] Manual review completed
40+
- [ ] Other:
41+
42+
```
43+
<!-- Paste relevant test/check output here -->
44+
```
45+
46+
## Risks
47+
48+
<!-- Identify any risks or potential issues -->
49+
| Risk | Level | Mitigation |
50+
|------|-------|------------|
51+
| None identified | - | - |
52+
53+
## Escalations
54+
55+
<!-- Were any escalations raised during this work? -->
56+
- [ ] No escalations required
57+
- [ ] Escalation raised and resolved:
58+
59+
## Checklist
60+
61+
- [ ] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) guidelines
62+
- [ ] My changes follow the existing documentation style
63+
- [ ] I have verified all links are valid
64+
- [ ] I have updated relevant index files (if applicable)
65+
- [ ] This PR is atomic (single logical change)
66+
67+
---
68+
69+
*Generated following [CHECKPOINTS.md](core/spec/CHECKPOINTS.md) requirements.*

0 commit comments

Comments
 (0)