🤝 How to Contribute to VERSA

[alpha912]

🤝 How to Contribute to VERSA

Thank you for your interest in contributing to VERSA! This guide will help you get started.

🎯 Ways to Contribute

1. 💬 Participate in Discussions

• Answer questions in Q&A
• Share ideas for improvements
• Vote in polls
• Give feedback on proposals

2. 🐛 Report Bugs

Use our bug report template to report issues with:

• Specification ambiguities
• CLI tool bugs
• Schema validation problems
• Adapter issues

3. 💡 Suggest Features

Use our feature request template to propose:

• New primitives or fields
• CLI enhancements
• Adapter improvements
• Documentation updates

4. 📝 Improve Documentation

• Fix typos and clarity issues
• Add examples and use cases
• Improve API documentation
• Write tutorials and guides

5. 🔧 Contribute Code

Specification Changes

1. Open an issue first to discuss the change
2. Update SPEC.md with clear rationale
3. Update schemas if needed
4. Add examples demonstrating the change
5. Submit a pull request

CLI Tool

1. Fork the dotaislash-cli repository
2. Create a feature branch
3. Add tests for your changes
4. Update documentation
5. Submit a pull request

Examples

1. Create a new folder in dotaislash-examples
2. Include complete .ai/ folder setup
3. Add README explaining the use case
4. Test with multiple tools if possible
5. Submit a pull request

Adapters

1. Fork the dotaislash-adapters repository
2. Implement the adapter interface
3. Add comprehensive tests
4. Document tool-specific quirks
5. Submit a pull request

📋 Pull Request Guidelines

1. Search first - Check if similar PR exists
2. One feature per PR - Keep changes focused
3. Write tests - Add tests for new functionality
4. Update docs - Keep documentation in sync
5. Follow templates - Use our PR template
6. Be patient - Reviews may take time

✅ Code Standards

TypeScript/JavaScript

• Use TypeScript strict mode
• Follow ESLint configuration
• Write comprehensive tests
• Document public APIs

Python

• Follow PEP 8
• Use type hints
• Write docstrings
• Add pytest tests

Documentation

• Use clear, concise language
• Include code examples
• Add links to related docs
• Test all commands/code

🏗️ Development Setup

CLI Tool

git clone https://github.com/dotAIslash/dotaislash-cli.git
cd dotaislash-cli
npm install
npm run build
npm test

Schemas

git clone https://github.com/dotAIslash/dotaislash-schemas.git
cd dotaislash-schemas
npm install
npm run validate

🎖️ Recognition

All contributors are recognized in:

• Repository README
• Release notes
• Contributors page

📞 Get Help

• Ask in Q&A Discussions
• Comment on the relevant issue
• Tag maintainers in discussions

📜 Code of Conduct

By participating, you agree to:

• Be respectful and inclusive
• Provide constructive feedback
• Focus on what's best for the community
• Show empathy towards others

Thank you for contributing to VERSA! 🙏