Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (43 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

57 lines (43 loc) · 1.47 KB
Raw

Contributing Guidelines

🌍 Language Policy

Code and Documentation

  • ALL code comments MUST be in English
  • ALL documentation files MUST be in English
  • ALL commit messages MUST be in English
  • ALL variable/function names MUST be in English
  • ALL README files MUST be in English

Exception

  • Russian is ONLY allowed in Claude Code chat for discussion
  • Any text that will be committed to the repository MUST be in English

📝 Code Style

Python

  • Follow PEP 8
  • Use descriptive variable names
  • Add docstrings to all functions
  • Keep functions small and focused

Comments

  • Write comments in English only
  • Explain WHY, not WHAT
  • Keep comments up-to-date with code changes

Commit Messages

  • Use conventional commits format
  • Start with emoji for visual clarity
  • Keep first line under 72 characters
  • Add detailed description if needed

Examples:

✨ Add new feature for tactical analysis
🐛 Fix game fetching timeout issue
📚 Update documentation for Lichess integration
♻️ Refactor analysis pipeline for better performance

🔧 Development Workflow

  1. Create a feature branch
  2. Make changes following these guidelines
  3. Test locally
  4. Commit with English message
  5. Push and create PR with English description

⚠️ Important

Remember: This is an international open-source project. English ensures maximum accessibility and collaboration.

These guidelines ensure consistency and international collaboration