We're thrilled that you're interested in contributing to Bitcoin Saga, the 2D retro RPG game that educates players about Bitcoin! This document provides guidelines for contributions that we encourage you to read thoroughly before starting.
Please use the issue tracker to report any bugs. Be as detailed as possible, providing:
- A clear title and description.
- Steps to reproduce.
- Expected vs. actual results.
- Any relevant screenshots.
Have ideas on how to make Bitcoin Saga even better? We'd love to hear them! Use the issue tracker to submit your suggestions.
Ready to dive into the code? Great! Here's how you can submit your pull requests (PRs):
- Fork the repository and create your branch from
main. - If you've added code, ensure it adheres to the existing style and has proper comments.
- Update the README.md with details of changes if applicable.
- Issue the pull request with a comprehensive list of changes.
To get started with development, you'll need Unity Version 2022.3.11f1 installed. Clone the repository, open the project in Unity, and you're ready to contribute.
- Write self-documenting code with meaningful variable and method names.
- Follow the Unity Coding Standards.
- Comment your code where necessary.
If you are adding new features, please update the documentation accordingly. This includes in-line code comments, external documentation files, and the project wiki if applicable.
Your contributions must adhere to the licensing agreements in place. By contributing, you agree that your contributions will be licensed under the same license as the project (see LICENSE file).
Thank you for being a part of our community and for contributing to Bitcoin Saga. Let's educate the world about Bitcoin through the fun of gaming!