Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (33 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

45 lines (33 loc) · 1.62 KB
Raw

Contributing to ARC IaC Agent Skills

Thank you for your interest in contributing! This project welcomes improvements from the community.

How to Contribute

Reporting Issues

  • Use the GitHub issues
  • Include your AI client (Claude, Cursor, Kiro, etc.), OS, and Python version
  • Provide a minimal reproduction when reporting bugs

Pull Requests

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/my-improvement
  3. Make your changes
  4. Test scripts/arc.py parses: 
    python3 -c "import ast, sys; ast.parse(open('scripts/arc.py').read())"
  5. Commit with a clear message
  6. Open a PR against the main branch

What to Contribute

Area Ideas
Skills New agent-specific skills (Section 1 changes only)
Engine Bug fixes, performance improvements, new CLI commands
Integrations Rules files for additional AI tools
Docs README improvements, new examples, clarity edits
Security New scan rules, compliance mappings

Agent-Specific vs Universal Changes

  • Universal content (Sections 2–10 of any SKILL.md): Make the change in one SKILL.md first, then replicate to the other two.
  • Agent-specific content (Section 1): Modify only the relevant agent's file.
  • Engine changes (scripts/arc.py): All skills reference the same script — update once.

Style Guidelines

  • Python: follow PEP 8; the engine is stdlib-only — no external dependencies
  • Markdown: 80-character soft wrap for readability
  • Skills: keep each SKILL.md self-contained; AI agents consume them as single documents