1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# Contributing to Peng Project
Thank you for your interest in contributing! Please follow these guidelines.
## Getting Started
1. **Fork the repository**: Click the "Fork" button at the top right of the repository page.
2. **Clone your fork**:
```sh
git clone https://github.com/makeecat/Peng.git
```
3. **Navigate to the project directory**:
```sh
cd Peng
```
4. **Build and run the project**:
```sh
cargo run
```
## How to Contribute
1. **Create a new branch**:
```sh
git checkout -b feature/your-feature-name
```
2. **Make your changes**.
3. **Test your changes**.
4. **Commit your changes**:
```sh
git commit -m "Brief description of your changes"
```
5. **Push to your fork**:
```sh
git push origin feature/your-feature-name
```
6. **Create a pull request**: Go to the repository on GitHub and click "New Pull Request".
## License
By contributing, you agree that your contributions will be licensed under the [GPL-3.0 License](LICENSE).