CONTRIBUTING.md

Contributing to Convex Skills

Thank you for your interest in contributing to Convex Skills.

How to Contribute

Reporting Issues

• Use GitHub Issues to report bugs or suggest features
• Include as much detail as possible
• For security issues, please email security@convex.dev directly

Submitting Changes

1. Fork the repository
2. Create a feature branch (git checkout -b feature/new-skill)
3. Make your changes
4. Test your changes thoroughly
5. Submit a pull request

Skill Guidelines

When creating or modifying skills:

1. Follow the Template: Use the Anthropic-approved skill format in skills/template/SKILL.md
2. Fetch Documentation: Always reference the latest Convex documentation
3. Include Examples: Provide working code examples
4. Test Thoroughly: Verify all code examples work correctly

Code Style

• Use TypeScript for all code examples
• Follow Convex best practices
• Include proper type annotations
• Add comments for complex logic

Commit Messages

• Use clear, descriptive commit messages
• Reference issue numbers when applicable
• Keep commits focused on single changes

Best Practices

When contributing:

• Never run npx convex deploy unless explicitly instructed
• Never run git commands without proper guidance
• Always verify documentation links are current
• Test all code examples before submitting

Questions

For questions about contributing, open a GitHub Discussion or reach out to the Convex team.

License

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