Contributing Guide#

Code of Conduct#

Please read our Code of Conduct.

Contributing Guidelines#

Getting Started
  1. Fork the repository

  2. Create a feature branch (git checkout -b awesome-feature)

  3. Make your changes

  4. Add tests for new functionality if needed

  5. Ensure all tests pass

  6. Submit a pull request

Development Standards
  • Follow existing code style and conventions

  • Write clear, descriptive commit messages

  • Include tests for new features

  • Update documentation as needed

  • Ensure backwards compatibility when possible

Types of Contributions
  • ๐Ÿ› Bug reports and fixes

  • โœจ New features and enhancements

  • ๐Ÿ“š Documentation improvements

  • ๐ŸŽจ UI/UX improvements

  • ๐Ÿงช Test coverage improvements

Communication Channels#

GitHub Discussions
  • General questions and help

  • Feature requests and ideas

  • Community showcases

  • Development discussions

Issues
  • Bug reports

  • Specific feature requests

  • Documentation issues

Pull Requests
  • Provide clear description of changes

  • Reference related issues

  • Include screenshots for UI changes

  • Ensure CI checks pass