Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
0xibs authored Sep 29, 2024
1 parent 6b67b27 commit f1acf75
Showing 1 changed file with 94 additions and 0 deletions.
94 changes: 94 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
**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:
```bash
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](https://github.com/sivicstudio/starkludo?tab=readme-ov-file#development).

### 3. Choose a Task

Browse the [issues list](https://github.com/sivicstudio/starkludo/issues) 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:
```bash
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:
```markdown
fix: implement new feature to handle game state change
```
### 5. Push Your Changes

Push your branch to the original repository:
```bash
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](https://t.me/+hnjQooODZOA2M2Rk) to discuss topics related to StarkLudo.

<!--
**Code Style**
-------------
### Code Conventions
Please follow our code conventions:
*
### Coding Standards
Adhere to the following coding standards:
-->

**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

0 comments on commit f1acf75

Please sign in to comment.