Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
makeecat authored Aug 1, 2024
1 parent ec61f30 commit 0bfb6bc
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,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).

0 comments on commit 0bfb6bc

Please sign in to comment.