We'd love to get your contributions to Gyrinx. The best way to identify how to contribute is to use Gyrinx and spot improvements!
While we are in a rapid development phase, the project is run BDFL-style:
- @tgvashworth is the final decision-maker on all aspects of design, development and operations
- Decision-making will be done in a benevolent-but-autocratic style, with some decisions delegated by expertise
- This may change as the project evolves, but it is the right choice for a very early project that is moving quickly
Before contributing, read our Code of Conduct — by joining the community, you're agreeing to adhere to the contents of that document.
- Do not open up a GitHub issue if the bug is a security vulnerability in Gyrinx. Instead, email hello@gyrinx.app or submit a Security Advisory.
- Ensure the bug was not already reported by searching on GitHub under Issues.
- If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible.
Thanks for fixing the bug!
- Open a new GitHub pull request with the patch.
- Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
- Ideally, include tests that cover the change.
- Suggest your change in the #core channel on our Discord and start writing code.
- Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.
- Ask any question about Gyrinx code & internals on the #core channel.
- For questions about content, head to the #content channel.
Thanks! ❤️