# 🤝 Contributing

We welcome contributions of all kinds! Here's how you can help:

## Ways to Contribute

- 🐛 Bug Reports: Open detailed issues on GitHub
- 💡 Feature Requests: Share ideas for improvements
- 🛠️ Code Contributions: Submit pull requests
- 📚 Documentation: Improve docs and examples
- 🧪 Testing: Add test cases and improve coverage

## 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**. Add tests for your changes in the inline documentation. Document public APIs
3. **Test your changes**.
   ```sh
   cargo test
   cargo fmt
   cargo clippy -- -D warnings
   ```
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:

- MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT)
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project shall be dual licensed as above, without any additional terms or conditions.