Contributing to TruchiEmu

Ways to Contribute

Code Contributions

• Bug fixes: Check GitHub Issues for open bugs
• New features: Propose features via GitHub Discussions first
• Performance improvements: Optimize emulation core integration or UI
• Shader development: Create custom Metal shaders

Non-Code Contributions

• Documentation: Improve guides, add examples, fix typos
• Testing: Test games across different systems and report compatibility
• Bug reports: File detailed issues with reproduction steps
• Community support: Help other users in Discussions and issues

Getting Started

1. Fork the TruchiEmu repository
2. Clone your fork: git clone https://github.com/YOUR_USERNAME/truchiemu.git
3. Create a feature branch: git checkout -b feature/your-feature-name
4. Make your changes following the project's code style
5. Build and test your changes locally
6. Submit a pull request

Contribution Guidelines

Code Style

• Follow existing code patterns and naming conventions
• Use SwiftUI best practices for UI changes
• Keep ObjC++ bridging to a minimum — prefer Swift where possible
• Document public APIs with appropriate comments

Pull Request Process

1. Ensure your PR addresses a single concern
2. Include a clear description of the changes
3. Reference any related issues
4. Update documentation if needed
5. Ensure the project builds successfully

Reporting Issues

When filing a bug report, please include:

• macOS version and hardware (Apple Silicon or Intel)
• TruchiEmu version
• Steps to reproduce the issue
• Expected vs actual behavior
• Crash logs or screenshots if applicable

Areas Needing Help

• Core integration: Improve compatibility with additional libretro cores
• Shader effects: Create new Metal shaders for different display types
• Documentation: Expand the docs site with more examples and guides
• Testing: Test game compatibility across different systems
• UI/UX: Refine the SwiftUI interface and add new features