Contributing Guide

June 24, 2025 · View on GitHub

Thank you for your interest in the EmmyLua2 project! We welcome contributions of all kinds.

🚀 How to Contribute

Reporting Bugs

If you find a bug, please:

  1. Check Issues to ensure the issue hasn't been reported
  2. Create a new Issue including:
    • Detailed problem description
    • Steps to reproduce
    • Expected behavior vs actual behavior
    • Environment information (IDE version, OS, etc.)
    • Relevant screenshots or logs

Feature Suggestions

For new feature suggestions:

  1. Discuss your idea in Discussions
  2. If you get positive feedback, create a Feature Request Issue

Code Contributions

  1. Fork the project
  2. Create a feature branch 
    git checkout -b feature/your-feature-name
  3. Commit changes 
    git commit -m "feat: add new feature description"
  4. Push to branch 
    git push origin feature/your-feature-name
  5. Create Pull Request

📝 Code Standards

Commit Message Format

Use Conventional Commits format:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Types:

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation update
  • style: Code formatting (no functional changes)
  • refactor: Refactoring
  • test: Test-related
  • chore: Build process or auxiliary tool changes

Code Style

  • Follow official Kotlin code style
  • Use meaningful variable and function names
  • Add appropriate comments
  • Ensure test coverage

🧪 Testing

Run tests:

./gradlew test

📚 Development Resources

❓ Need Help?

Thank you for your contributions! 🎉