83 lines
2.7 KiB
Markdown
83 lines
2.7 KiB
Markdown
|
---
|
||
|
|
name: sdlc-standards
|
||
|
|
description: Inject cross-cutting non-functional requirements into AI agent context during software development. Use when starting work on a Jira story, designing a feature, implementing code, or preparing for deployment. Pulls security, architecture, DevOps, and cost requirements from the standards mono repo at the appropriate development phase.
|
||
|
|
---
|
||
|
|
|
||
|
|
# SDLC Standards Skill
|
||
|
|
|
||
|
|
Provides non-functional requirements to your AI agent based on the current development phase.
|
||
|
|
|
||
|
|
## Setup
|
||
|
|
|
||
|
|
Clone the standards repo into your workspace:
|
||
|
|
```bash
|
||
|
|
git clone <standards-repo-url> .standards
|
||
|
|
```
|
||
|
|
|
||
|
|
Or add as a git submodule:
|
||
|
|
```bash
|
||
|
|
git submodule add <standards-repo-url> .standards
|
||
|
|
```
|
||
|
|
|
||
|
|
## When to Load Requirements
|
||
|
|
|
||
|
|
| Phase | Load these | Why |
|
||
|
|
|-------|-----------|-----|
|
||
|
|
| Design / Exploration | `architecture/requirements.md` | API contracts, service boundaries, breaking change protocol |
|
||
|
|
| Implementation | `security/requirements.md` | Input validation, auth, secrets, SQL safety |
|
||
|
|
| Deployment config | `devops/requirements.md`, `cost/requirements.md` | Health checks, logging, resource limits, tagging |
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
When starting a new story, tell your agent:
|
||
|
|
|
||
|
|
> Before implementing, read the requirements from `.standards/` that apply to this phase. For design work, read `.standards/architecture/requirements.md`. For implementation, read `.standards/security/requirements.md`. For deployment changes, read `.standards/devops/requirements.md` and `.standards/cost/requirements.md`.
|
||
|
|
|
||
|
|
Or configure your agent rules to auto-load:
|
||
|
|
|
||
|
|
### Cursor (.cursor/rules)
|
||
|
|
```
|
||
|
|
When working on this project, check .standards/ for non-functional requirements.
|
||
|
|
Load architecture requirements during design. Load security requirements during implementation.
|
||
|
|
Load devops and cost requirements when modifying deployment configs.
|
||
|
|
```
|
||
|
|
|
||
|
|
### OpenSpec (openspec.config.yaml)
|
||
|
|
```yaml
|
||
|
|
context:
|
||
|
|
- path: .standards/architecture/requirements.md
|
||
|
|
phase: propose
|
||
|
|
- path: .standards/security/requirements.md
|
||
|
|
phase: apply
|
||
|
|
- path: .standards/devops/requirements.md
|
||
|
|
phase: apply
|
||
|
|
```
|
||
|
|
|
||
|
|
### Claude Code (CLAUDE.md)
|
||
|
|
```markdown
|
||
|
|
## Standards
|
||
|
|
Before implementing, read applicable requirements from `.standards/`:
|
||
|
|
- Design: `.standards/architecture/requirements.md`
|
||
|
|
- Code: `.standards/security/requirements.md`
|
||
|
|
- Deploy: `.standards/devops/requirements.md` and `.standards/cost/requirements.md`
|
||
|
|
```
|
||
|
|
|
||
|
|
## CI Integration
|
||
|
|
|
||
|
|
Run the compliance checker in your pipeline:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
bash .standards/.tests/check.sh . --diff main
|
||
|
|
```
|
||
|
|
|
||
|
|
Returns exit code 0 (pass/warn) or 1 (violations). Start with `|| true` to make it informational, remove when ready to enforce.
|
||
|
|
|
||
|
|
```groovy
|
||
|
|
// Jenkinsfile example
|
||
|
|
stage('Standards Check') {
|
||
|
|
steps {
|
||
|
|
sh 'bash .standards/.tests/check.sh . --diff main || true'
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|