Skip to content

Commit 3f0f1d4

Browse files
authored
Document AI setup in template along with reusable workflows (#700)
* Document AI setup in template along with reusable workflows * Implement Claude feedback
1 parent b76d972 commit 3f0f1d4

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

docs/contributing/template-repository.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,39 @@ Actions workflows for code scanning. Targets two domains:
105105
push events.
106106
- Quality: Additional language-specific findings and improvements not strictly related to security.
107107

108+
Each above domain-specific scanner calls a reusable workflow in the `gh-actions` repository.
109+
108110
SAST results are exported as
109111
[SARIF](https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html) (Static Analysis Results
110112
Interchange Format) and uploaded to the GitHub Advanced Security interface for internal review.
111113
Quality results are also made available in the interface when security-related.
114+
115+
## AI
116+
117+
Initial content placeholders provide AI assistance and automated code reviews:
118+
119+
```
120+
.claude/
121+
├── CLAUDE.md # General project context, guidelines, and instructions
122+
├── commands/ # Custom slash commands
123+
└── prompts/
124+
└── review-code.md # Code review prompt
125+
```
126+
127+
### Automated reviews
128+
129+
Actions workflows for review of issues and pull requests. Targets two use cases:
130+
131+
- Review of non-draft pull requests: The above `review-code.md` Markdown file is used as a gate to
132+
execute the workflow. Repositories without this file will not have automated code reviews
133+
performed. Reviews are posted via a persistent comment that updates with new commits.
134+
- Response: By mentioning `@claude` in issue or pull request (including inline) comments. Specific
135+
responses to the mention will be generated.
136+
137+
Each above use case calls a reusable workflow in the `gh-actions` repository.
138+
139+
### Best practices
140+
141+
- Commands (`.claude/commands/`): For interactive Claude Code sessions.
142+
- Prompts (`.claude/prompts/`): For automated GitHub Actions workflows.
143+
- `CLAUDE.md`: General project context available in all Claude interactions.

0 commit comments

Comments
 (0)