Skip to content

chore: add best-practice repo structure and CI#5

Merged
msaad00 merged 4 commits intomainfrom
enhance/best-practices
Apr 9, 2026
Merged

chore: add best-practice repo structure and CI#5
msaad00 merged 4 commits intomainfrom
enhance/best-practices

Conversation

@msaad00
Copy link
Copy Markdown
Owner

@msaad00 msaad00 commented Apr 8, 2026

Summary

Production-grade repo scaffolding for the cloud-security skills collection.

New files

File Purpose
CLAUDE.md Skill collection discovery for Claude Code/Desktop — repo structure, conventions, security model, run instructions
LICENSE Apache 2.0 (was referenced in README but file was missing)
SECURITY.md Vulnerability reporting policy with 48h ack / 7d assessment / 14d fix SLAs
CONTRIBUTING.md Guidelines for adding new skills with SKILL.md frontmatter requirements
.github/workflows/ci.yml 4-job CI: lint (ruff), test (pytest+moto), validate CloudFormation (cfn-lint), validate Terraform, security scan (bandit + secret grep)
pyproject.toml Repo-level ruff, bandit, pytest configuration

README enhancements

  • Added CI status, license, Python version badges
  • Replaced all ASCII architecture diagrams with Mermaid flowcharts (renders natively on GitHub, dark-theme compatible)
  • Mermaid diagrams for: IAM departures pipeline, CSPM benchmarks, vuln remediation pipeline, security model
  • Expanded compliance framework mapping (added OWASP LLM/MCP, PCI DSS 4.0)
  • Added contributing/security sections
  • Comprehensive .gitignore (Python, Terraform, IDE, secrets)

SKILL.md compliance

All 5 SKILL.md files already follow Anthropic's skill spec:

  • Frontmatter: name, description (with "Use when the user mentions..." trigger phrases), license, compatibility, metadata
  • Architecture diagrams, compliance mappings, deployment instructions

Test plan

  • CI workflow validates: ruff lint, pytest, cfn-lint, terraform validate, bandit
  • All Mermaid diagrams render on GitHub (tested in preview)
  • CLAUDE.md provides complete context for Claude Code discovery

msaad00 added 4 commits April 8, 2026 19:19
Add production-grade repo scaffolding:

- CLAUDE.md — skill collection discovery for Claude Code/Desktop with
  repo structure, conventions, security model, and run instructions
- LICENSE — Apache 2.0 (was referenced in README but file was missing)
- SECURITY.md — vulnerability reporting policy with response SLAs
- CONTRIBUTING.md — guidelines for adding new skills with SKILL.md
  frontmatter requirements and code standards
- .gitignore — comprehensive Python/Terraform/IDE/secrets exclusions
  (was only __pycache__/)
- pyproject.toml — ruff, bandit, pytest configuration for repo-level
  tooling
- .github/workflows/ci.yml — 4-job CI pipeline:
  - lint (ruff check + format)
  - test-iam-departures (pytest with moto)
  - validate-cloudformation (cfn-lint on both templates)
  - validate-terraform (terraform init + validate)
  - security-scan (bandit + hardcoded secret grep)

README enhanced:
- Added CI, license, Python version badges
- Replaced ASCII architecture diagrams with Mermaid flowcharts
  (renders natively on GitHub, dark-theme compatible)
- Added Mermaid diagrams for all 3 architectures:
  IAM departures, CSPM benchmarks, vuln remediation pipeline
- Added security model Mermaid diagram (zero trust / least privilege /
  defense in depth)
- Expanded compliance framework mapping table with OWASP + PCI DSS
- Added contributing and security sections with links
- Added agent-bom skills scan to quick start

SKILL.md files already follow Anthropic's skill spec:
- Frontmatter: name, description (with trigger phrases), license,
  compatibility, metadata (author, version, frameworks, cloud)
- "Use when the user mentions..." pattern for Claude invocation
- Each SKILL.md has architecture diagrams, compliance mappings,
  deployment instructions, and usage examples
…ix unused variable, use pyproject.toml config
@msaad00 msaad00 merged commit b8877a0 into main Apr 9, 2026
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant