52 lines (37 loc) · 1.72 KB

Contributing to CrewKit

CrewKit is built for teams and leaders. We welcome contributions, ideas, and feedback to make it better.

How to Contribute

Report Issues

Found a bug or have a suggestion? Open an issue with:

Clear description of the problem or feature request
Steps to reproduce (for bugs)
Expected vs. actual behavior
Your browser and OS version

Submit Code Changes

Fork the repository
Create a branch for your feature: git checkout -b feature/your-feature-name
Make your changes — keep code clean and well-structured
Test thoroughly — open index.html in your browser and verify functionality
Commit with clear messages: git commit -m "Add feature: description"
Push to your fork and create a pull request

Code Guidelines

Vanilla JavaScript — no build tools or dependencies (keep it simple)
HTML/CSS/JS — edit directly in the files
Comments — explain why, not what the code does
Testing — use the test suite: open tests/tests.html in a browser

Documentation

If you change functionality:

Update README.md with any new features or changes
Update the schema in setup.json section if needed
Add notes to how-it-works.html if it affects user workflows

What We're Looking For

Bug fixes and stability improvements
New evaluation framework types or assessment templates
UI/UX improvements for existing features
Better browser support
Documentation and examples
Community use cases and feedback

Questions?

Open an issue or reach out directly. We're here to help make CrewKit work better for your team.

CrewKit is meant to evolve with the needs of teams. Your contributions are welcome!