Skip to content

Latest commit

 

History

History
59 lines (48 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

59 lines (48 loc) · 1.69 KB
Raw

🤝 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: 
    git clone https://github.com/makeecat/Peng.git
  3. Navigate to the project directory: 
    cd Peng
  4. Build and run the project: 
    cargo run

How to Contribute

  1. Create a new branch: 
    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. 
    cargo test
cargo fmt
cargo clippy -- -D warnings
  4. Commit your changes: 
    git commit -m "Brief description of your changes"
  5. Push to your fork: 
    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:

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.