CONTRIBUTING.md

Contributing to the A3-Python Claude Skill

Thank you for your interest in contributing to this skill!

About This Skill

This Claude skill enables AI agents to work with a3-python, an advanced static analysis tool for Python codebases. The skill provides instructions, examples, and configuration templates.

File Structure

a3-python-skill/
├── SKILL.md                      # Main skill specification (required)
├── README.md                      # Documentation
├── LICENSE                        # MIT License
├── .a3.yml.example               # Example configuration
├── resources/
│   └── quick-reference.md        # Command reference
└── CONTRIBUTING.md               # This file

Modifying the Skill

SKILL.md Format

The SKILL.md file must follow this structure:

1. YAML Frontmatter (required):

   ---
   name: a3-python
   description: Clear description of what the skill does
   ---

2. Markdown Instructions: Clear instructions for Claude to follow

Requirements

• The name field must match the repository/skill name
• The description should clearly explain when to use the skill
• Instructions should be clear, actionable, and comprehensive
• Include examples where helpful
• Keep supporting files in the resources/ directory

Testing Changes

To test modifications:

1. Validate YAML frontmatter:

   python3 -c "import yaml; yaml.safe_load(open('SKILL.md').read().split('---')[1])"

2. Check for required sections:

   • Installation instructions
   • Usage examples
   • Configuration guidance

3. Ensure examples are accurate and up-to-date with a3-python documentation

Submitting Changes

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Test the skill specification
5. Submit a pull request with:
   • Clear description of changes
   • Reason for the changes
   • Any updated examples or documentation

Style Guidelines

• Use clear, concise language
• Provide concrete examples with code blocks
• Use proper Markdown formatting
• Keep line lengths reasonable (80-120 chars recommended)
• Use consistent heading levels

Updating for New A3-Python Versions

When a3-python is updated:

1. Review the a3-python PyPI page
2. Update commands and flags if changed
3. Add new features to the skill documentation
4. Update examples to reflect best practices
5. Test that all examples still work

Resources

• Agent Skills Specification
• a3-python on PyPI
• Claude Skills Documentation

Questions?

If you have questions about contributing, please open an issue in the repository.