Thank you for your interest in contributing to RiichiEnv! This document provides guidelines and information to help you get started.
We welcome valuable contributions, even if they are AI-generated. You, as a human, are responsible for judging whether your contribution is valuable.
Please be respectful and constructive in all interactions. We are committed to providing a welcoming and inclusive experience for everyone.
There are many ways to contribute:
- Report bugs — If you find a bug, please open an issue with a clear description and steps to reproduce
- Suggest features — Have an idea? Open an issue to discuss it
- Submit pull requests — Bug fixes, new features, documentation improvements are all welcome
- Review pull requests — Help review other contributors' pull requests
- Improve documentation — Fix typos, clarify explanations, or add missing information
Prerequisites, build instructions, testing, linting, benchmarks, and other development details are documented in docs/DEVELOPMENT_GUIDE.md.
Before submitting a pull request, make sure all pre-commit checks pass:
uv run pre-commit run --config .pre-commit-config.yamlBut honestly, I forget to run this all the time and end up failing CI myself — so don't worry if it happens to you too.
When reporting a bug, please include:
- A clear and descriptive title
- Steps to reproduce the issue
- Expected behavior
- Actual behavior
- Environment details (OS, Rust version, Python version)
- Any relevant logs or error messages
But honestly, you don't have to include all of the above. Skip anything you think isn't relevant. If we need more info, we'll ask. Feel free to report casually!
By contributing to RiichiEnv, you agree that your contributions will be licensed under the Apache License 2.0.