Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
173 lines (131 loc) · 3.9 KB

CONTRIBUTING.md

File metadata and controls

173 lines (131 loc) · 3.9 KB

Contributing to MelonLoader

🎮 Thanks for your interest in contributing to MelonLoader! This project makes Unity game modding accessible to everyone.

🚀 Quick Start

Types of Contributions We Welcome

  • 🐛 Bug Reports - Help us squash those pesky issues
  • 💡 Feature Requests - Suggest new functionality
  • 🔧 Code Contributions - Submit pull requests
  • 📝 Documentation - Improve guides and tutorials
  • 🎯 Testing - Test on different Unity versions
  • 🌍 Translations - Help international users

🐛 Reporting Bugs

Before Submitting

  1. Check existing issues
  2. Test with the latest version
  3. Try with a clean Unity project

Bug Report Template

**Unity Version:** [e.g. 2021.3.15f1]
**MelonLoader Version:** [e.g. 0.7.0]
**OS:** [e.g. Windows 11]
**Game/App:** [if applicable]

**Expected Behavior:**
What should happen?

**Actual Behavior:**
What actually happens?

**Steps to Reproduce:**
1. Step one
2. Step two
3. Step three

**Additional Info:**
- Console logs
- Screenshots
- Error messages

💡 Feature Requests

Great features start with great ideas! Before submitting:

  • Check if it already exists in issues/discussions
  • Consider if it fits MelonLoader's scope
  • Think about implementation complexity

Use our Feature Request Template

🔧 Code Contributions

Development Setup

# Clone the repository
git clone https://github.com/Lava-Gang/melonloader.git
cd melonloader

# Create a feature branch
git checkout -b feature/your-feature-name

Coding Standards

  • Use C# naming conventions
  • Add XML documentation for public APIs
  • Include unit tests where applicable
  • Keep commits focused and atomic

Pull Request Process

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Test thoroughly
  5. Submit a pull request

PR Template

## Changes
- What changed?
- Why was it changed?

## Testing
- How was it tested?
- Which Unity versions?

## Screenshots
(if applicable)

## Checklist
- [ ] Code follows style guidelines
- [ ] Self-review completed
- [ ] Tests added/updated
- [ ] Documentation updated

🧪 Testing Guidelines

Test Requirements

  • Test on multiple Unity versions (2019.4+)
  • Test both IL2CPP and Mono builds
  • Test common mod scenarios
  • Verify backwards compatibility

Test Environments

  • Windows 10/11
  • Unity Editor versions
  • Standalone builds
  • Different architectures (x64, x86)

📝 Documentation

Areas Needing Help

  • API documentation
  • Modding tutorials
  • Troubleshooting guides
  • Video tutorials
  • Translations

Style Guide

  • Use clear, concise language
  • Include code examples
  • Add screenshots where helpful
  • Keep beginner-friendly tone

🌍 Internationalization

Help make MelonLoader accessible worldwide:

  • Translate error messages
  • Create localized documentation
  • Test with non-English Unity installs

📞 Getting Help

Stuck? Ask Questions!

Response Times

  • Issues: 2-3 business days
  • PRs: 3-5 business days
  • Discord: Usually same day

🏆 Recognition

All contributors get:

  • Listed in CHANGELOG.md
  • GitHub contributor badge
  • Special role in Discord
  • Our eternal gratitude! 🙏

📜 Code of Conduct

This project follows our Code of Conduct. Please read it before participating.

🎯 Priority Areas

Currently seeking help with:

  • Unity 2023 compatibility
  • Performance optimization
  • Mobile platform support
  • Better error handling
  • Automated testing

Ready to contribute? Start by browsing good first issues!

Made with ❤️ by the MelonLoader community