Skip to content

Commit 0619751

Browse files
Ambient Code Botclaude
Ambient Code Bot
and
claude
committed
Phase 3 Stream 3: CI/CD infrastructure complete
- Create .github/ISSUE_TEMPLATE/bug_report.yml (structured bug reports) - Create .github/ISSUE_TEMPLATE/feature_request.yml (structured feature requests) - Create .github/PULL_REQUEST_TEMPLATE.md (comprehensive PR template) - Create .github/workflows/validate-docs.yml (6 parallel validation jobs) - Create scripts/lint-all.sh (unified validation runner) - Create docs/diagrams/buffet-approach.mmd (feature adoption diagram) - Create docs/diagrams/ci-cd-pipeline.mmd (complete CI/CD flow) Stream 3 provides complete CI/CD automation: - GitHub issue templates for bugs and features - PR template with comprehensive checklists - Automated validation (markdown, doc pairs, diagrams, scripts, links, style) - Unified lint-all.sh for local validation - Visual diagrams for buffet approach and CI/CD pipeline 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent cb0a6e3 commit 0619751

File tree

7 files changed

+1004
-0
lines changed

7 files changed

+1004
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
name: Bug Report
2+
description: Report a bug or issue with the template
3+
title: "[BUG] "
4+
labels: ["bug"]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to report a bug! Please fill out the information below to help us understand and reproduce the issue.
12+
13+
- type: textarea
14+
id: description
15+
attributes:
16+
label: Bug Description
17+
description: A clear and concise description of what the bug is.
18+
placeholder: Describe the problem you encountered...
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: reproduction
24+
attributes:
25+
label: Steps to Reproduce
26+
description: Steps to reproduce the behavior
27+
placeholder: |
28+
1. Run setup.sh
29+
2. Execute check-doc-pairs.sh
30+
3. See error
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: expected
36+
attributes:
37+
label: Expected Behavior
38+
description: What you expected to happen
39+
placeholder: Script should pass validation...
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: actual
45+
attributes:
46+
label: Actual Behavior
47+
description: What actually happened
48+
placeholder: Script failed with error...
49+
validations:
50+
required: true
51+
52+
- type: dropdown
53+
id: component
54+
attributes:
55+
label: Component
56+
description: Which part of the template is affected?
57+
options:
58+
- Documentation
59+
- Scripts (setup, validation, etc.)
60+
- CI/CD Workflows
61+
- Agent Configuration
62+
- Diagrams
63+
- Templates
64+
- Other
65+
validations:
66+
required: true
67+
68+
- type: textarea
69+
id: environment
70+
attributes:
71+
label: Environment
72+
description: Information about your environment
73+
placeholder: |
74+
- OS: [e.g., Ubuntu 22.04, macOS 14]
75+
- Shell: [e.g., bash 5.1, zsh 5.9]
76+
- Git version: [e.g., 2.40.0]
77+
- Node version (if applicable): [e.g., 20.10.0]
78+
value: |
79+
- OS:
80+
- Shell:
81+
- Git version:
82+
- Node version:
83+
validations:
84+
required: true
85+
86+
- type: textarea
87+
id: logs
88+
attributes:
89+
label: Error Logs
90+
description: Relevant error messages or logs
91+
placeholder: Paste error output here...
92+
render: shell
93+
94+
- type: textarea
95+
id: context
96+
attributes:
97+
label: Additional Context
98+
description: Any other context about the problem
99+
placeholder: This started happening after...
100+
101+
- type: checkboxes
102+
id: checks
103+
attributes:
104+
label: Pre-submission Checklist
105+
description: Please verify the following before submitting
106+
options:
107+
- label: I have searched existing issues to avoid duplicates
108+
required: true
109+
- label: I have provided all requested information
110+
required: true
111+
- label: I have included error logs/output if applicable
112+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement for the template
3+
title: "[FEATURE] "
4+
labels: ["enhancement"]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for suggesting a feature! Please provide as much detail as possible to help us understand your request.
12+
13+
- type: textarea
14+
id: problem
15+
attributes:
16+
label: Problem Statement
17+
description: What problem does this feature solve?
18+
placeholder: I'm trying to do X but the template doesn't support it...
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: solution
24+
attributes:
25+
label: Proposed Solution
26+
description: How would you like this feature to work?
27+
placeholder: Add a new script that...
28+
validations:
29+
required: true
30+
31+
- type: dropdown
32+
id: component
33+
attributes:
34+
label: Component
35+
description: Which part of the template should this feature affect?
36+
options:
37+
- Documentation
38+
- Scripts (setup, validation, etc.)
39+
- CI/CD Workflows
40+
- Agent Configuration
41+
- Diagrams
42+
- Templates
43+
- Other
44+
validations:
45+
required: true
46+
47+
- type: dropdown
48+
id: priority
49+
attributes:
50+
label: Priority
51+
description: How important is this feature to you?
52+
options:
53+
- Critical - Blocking my adoption
54+
- High - Would significantly improve usability
55+
- Medium - Nice to have
56+
- Low - Minor improvement
57+
validations:
58+
required: true
59+
60+
- type: textarea
61+
id: alternatives
62+
attributes:
63+
label: Alternatives Considered
64+
description: What other approaches have you considered?
65+
placeholder: I've tried workaround X, but...
66+
67+
- type: textarea
68+
id: examples
69+
attributes:
70+
label: Examples
71+
description: Provide examples of how this would work
72+
placeholder: |
73+
```bash
74+
# New command example
75+
./scripts/new-feature.sh --option value
76+
```
77+
78+
- type: textarea
79+
id: context
80+
attributes:
81+
label: Additional Context
82+
description: Any other information that would help
83+
placeholder: This would be useful because...
84+
85+
- type: dropdown
86+
id: buffet
87+
attributes:
88+
label: Buffet Approach Compatibility
89+
description: Can this feature be adopted independently?
90+
options:
91+
- "Yes - Works standalone"
92+
- "Partial - Requires some dependencies"
93+
- "No - Requires multiple components"
94+
- "Unsure"
95+
validations:
96+
required: true
97+
98+
- type: checkboxes
99+
id: volunteer
100+
attributes:
101+
label: Implementation
102+
description: Are you willing to help?
103+
options:
104+
- label: I'm willing to implement this feature
105+
- label: I can help with documentation
106+
- label: I can help with testing
107+
108+
- type: checkboxes
109+
id: checks
110+
attributes:
111+
label: Pre-submission Checklist
112+
description: Please verify the following before submitting
113+
options:
114+
- label: I have searched existing feature requests to avoid duplicates
115+
required: true
116+
- label: This feature aligns with the template's infrastructure-only scope
117+
required: true
118+
- label: I have provided sufficient detail for evaluation
119+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
## Summary
2+
3+
<!-- Provide a brief description of what this PR does -->
4+
5+
Closes #<!-- issue number -->
6+
7+
## Changes
8+
9+
<!-- List the specific changes made -->
10+
11+
- [ ] Documentation updates
12+
- [ ] Script modifications
13+
- [ ] Workflow changes
14+
- [ ] Agent configuration updates
15+
- [ ] Diagram additions/updates
16+
- [ ] Other: <!-- describe -->
17+
18+
## Type of Change
19+
20+
<!-- Mark with [x] -->
21+
22+
- [ ] Bug fix (non-breaking change that fixes an issue)
23+
- [ ] New feature (non-breaking change that adds functionality)
24+
- [ ] Breaking change (fix or feature that would break existing usage)
25+
- [ ] Documentation update
26+
- [ ] Refactoring (no functional changes)
27+
28+
## Testing Done
29+
30+
<!-- Describe the testing you performed -->
31+
32+
- [ ] Ran `./scripts/setup.sh` successfully
33+
- [ ] Ran `./scripts/check-doc-pairs.sh` - all pairs exist
34+
- [ ] Ran `./scripts/validate-mermaid.sh` - diagrams valid
35+
- [ ] Tested documentation in comparison page
36+
- [ ] Manual testing performed: <!-- describe -->
37+
38+
## Documentation Checklist
39+
40+
<!-- For PRs that include documentation -->
41+
42+
- [ ] Both standard and Terry versions created
43+
- [ ] Follows `docs/STYLE_GUIDE.md` guidelines
44+
- [ ] ZeroMQ-style writing (succinct, no AI slop)
45+
- [ ] "What Just Happened?" sections in Terry version
46+
- [ ] Added to comparison page navigation (if new topic)
47+
- [ ] No Red Hat branding
48+
- [ ] No "Amber" terminology (use "Codebase Agent" or "CBA")
49+
50+
## Infrastructure Validation
51+
52+
<!-- Ensure template remains infrastructure-only -->
53+
54+
- [ ] No application code added (`src/`, `app/`, `lib/` directories)
55+
- [ ] No framework imports (FastAPI, Django, Flask, etc.)
56+
- [ ] No database schemas or business logic
57+
- [ ] Patterns remain technology-agnostic
58+
59+
## Security Checklist
60+
61+
<!-- Verify no security issues introduced -->
62+
63+
- [ ] No secrets committed (API keys, passwords, tokens)
64+
- [ ] No hardcoded credentials
65+
- [ ] `.gitignore` updated if new file types added
66+
- [ ] Security best practices followed (if applicable)
67+
68+
## Buffet Approach Validation
69+
70+
<!-- Ensure feature can be adopted independently -->
71+
72+
- [ ] Feature can be extracted and used standalone
73+
- [ ] Dependencies clearly documented (if any)
74+
- [ ] No forced coupling with other features
75+
- [ ] Works without requiring full template adoption
76+
77+
## CI/CD Checks
78+
79+
<!-- These run automatically, but verify locally first -->
80+
81+
- [ ] Security checks pass (no secrets, app code, branding)
82+
- [ ] Documentation validation passes (lint, pairs, syntax)
83+
- [ ] All scripts are executable (`chmod +x`)
84+
- [ ] Shellcheck passes (for script changes)
85+
86+
## Screenshots / Examples
87+
88+
<!-- If applicable, add screenshots or examples showing the changes -->
89+
90+
```
91+
<!-- Paste examples here -->
92+
```
93+
94+
## Additional Context
95+
96+
<!-- Any other information reviewers should know -->
97+
98+
---
99+
100+
## Reviewer Guidance
101+
102+
**For Reviewers**: Please verify:
103+
104+
1. **Documentation Quality**: ZeroMQ-style, no excessive enthusiasm, both versions present
105+
2. **Infrastructure-Only**: No application code, stays focused on patterns/config
106+
3. **Buffet Approach**: Feature is independently adoptable
107+
4. **Security**: No secrets, follows security standards
108+
5. **Testing**: Changes are validated and tested
109+
110+
**Agent Reviews**: If requesting `@codebase-agent` review, specify focus area:
111+
- `@codebase-agent review for security` - Security-focused review
112+
- `@codebase-agent review for style` - Style guide compliance
113+
- `@codebase-agent review for patterns` - Architectural pattern validation

0 commit comments

Comments
 (0)