First off, thank you for considering contributing to BlockChess! It's people like you that make open-source projects like this thrive.
- Bug Reports: If you find a bug, please open an issue on the project's GitHub repository. Be sure to include as much detail as possible, including steps to reproduce the bug.
- Feature Requests: If you have an idea for a new feature, feel free to open an issue to discuss it. We're always open to new ideas!
- Pull Requests: If you've written some code that you'd like to contribute, please open a pull request. We'll review it as soon as we can.
- Fork the repository: Click the "Fork" button on the top right of the repository page.
- Clone your fork:
git clone https://github.com/your-username/blockchess.git - Create a branch:
git checkout -b my-new-feature - Make your changes: Write your code and add any necessary tests.
- Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Create a new Pull Request: Go to the original repository and create a new pull request.
Please follow the existing coding style in the project. We use Kotlin, and we generally follow the official Kotlin coding conventions.
- Keep it focused: Each pull request should address a single issue or feature.
- Write a good description: Explain what your pull request does and why it's needed.
- Be patient: We'll do our best to review your pull request as quickly as possible, but please be patient.
Thank you for your contributions!