# Contributing to create-ai-dev-vault

Thanks for your interest in contributing! This project welcomes contributions of all kinds.

## How to Contribute

### Reporting Issues

- Use [GitHub Issues](https://github.com/mmayasaurus/create-ai-dev-vault/issues)
- Include your OS, Node.js version, Python version, and Claude Code version
- Include the output of `python3 health-check.py --json` if relevant

### Suggesting Features

- Open an issue with the `enhancement` label
- Describe the problem you're trying to solve, not just the solution
- If it's an agent or hook improvement, explain the failure mode it prevents

### Pull Requests

1. Fork the repo
2. Create a feature branch: `git checkout -b feature/my-improvement`
3. Make your changes
4. Run the health check: `python3 health-check.py`
5. Test with a fresh install: `node bin/create.js /tmp/test-vault`
6. Submit a PR with a clear description

### What Makes a Good Contribution

- **New agents** — If you've built a specialized agent for a specific domain (data science, DevOps, ML, etc.), we'd love to include it as an optional template
- **New hooks** — Safety hooks that prevent common mistakes
- **Script improvements** — Better search algorithms, new analysis tools
- **Documentation** — Tutorials, guides, examples
- **Bug fixes** — Always welcome

### Code Style

- Python: Follow PEP 8, use type hints where practical
- JavaScript: Standard style, const over let
- Shell: Use `shellcheck` compatible patterns
- Markdown: ATX-style headers, tables for structured data

## License

By contributing, you agree that your contributions will be licensed under the Apache 2.0 License.