Skip to content

Latest commit

 

History

History
94 lines (59 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

94 lines (59 loc) · 2.37 KB
Raw

Welcome to StarkLudo!

Thank you for considering contributing to StarkLudo, the Ludo game on Starknet. This document outlines the guidelines and processes for contributing to the project.

Getting Started

1. Clone the Repository

Clone the StarkLudo repository to your local machine using the following command:

git clone https://github.com/sivicstudio/starkludo.git

2. Set up the Development Environment

Make sure you have the necessary tools and dependencies installed. For more information, refer to the README.md.

3. Choose a Task

Browse the issues list and choose a task that interests you. Make sure it's labeled as "help wanted" or "ready for pickup".

Contributing Code

1. Create a Branch

Create a new branch for your feature or bug fix using the following command:

git checkout -b dev/your-branch-name

2. Write Your Code

Write your code and follow the coding conventions (if any).

3. Test Your Code

Test your code thoroughly to ensure it works as expected.

4. Commit Your Changes

Commit your changes using a descriptive commit message. For example:

fix: implement new feature to handle game state change

5. Push Your Changes

Push your branch to the original repository:

git push origin dev/your-branch-name

Code Review

Once you've pushed your changes, a reviewer will be assigned to review your code. Follow the reviewer's feedback to resolve any issues.

Pull Request

Once your code review is complete, create a pull request to merge your branch into the dev branch.

Communication

1. Use GitHub Issues

Report any issues or concerns using the issue tracker.

2. Use Telegram (or other communication channels)

Join our Telegram channel to discuss topics related to StarkLudo.

Thanks!

We appreciate your contributions to StarkLudo! If you have any questions or concerns, don't hesitate to reach out.

Telegram: https://t.me/+hnjQooODZOA2M2Rk