Skip to content

🤝 Contributing Guide

Thank you for your interest in the project! Here's how you can contribute:

🚀 Getting Started

  1. Fork the repository
  2. Create a new branch: 
    git checkout -b feature/your_feature
  3. Make all necessary changes
  4. Be sure to test your code
  5. Create a Pull Request to main or dev (confirm if unsure)

✅ What We Appreciate

  • Improving documentation
  • Reporting issues
  • New features (ideally after discussion)
  • Adding new tests for existing functionality

🧹 Code Style

  • Follow formatting and style guidelines (eslint/black/prettier)
  • Try to write meaningful commit messages: 
    feature: Added support for X
fix: Fixed bug Y
docs: Updated documentation

image

🌐 Want to Help with Translation?

We aim to make the project accessible to as many people as possible. If you'd like to help translate into another language — it's very welcome!

📄 Available translations: - en English (default) - 🇷🇺 Russian - 🌐 Your language? Help us add it!

To get started, simply create an issue to let us know.

🛠 Best Practices

  • Use stable dependency versions listed in package.json / requirements.txt / pyproject.toml
  • Follow the project's coding style (e.g., via eslint, black, prettier, etc.)
  • Write readable and self-documenting code
  • Try to cover new functionality with tests
  • Before creating an issue — check if a similar one already exists
  • Create feature branches and submit pull requests with clear descriptions

✍️ Developer Certificate of Origin (DCO)

Thank you for your contribution! To ensure transparency and legal clarity in the project, we use the Developer Certificate of Origin (DCO).