Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 3.92 KB

README.md

File metadata and controls

81 lines (55 loc) · 3.92 KB

Rust template GitHub License

Static Badge codecov Integration test for Rust

Conventional Commits

Rust template that contains automatic benchmarking, automatic mutation testing, automatic fuzz testing.

Resources

Customizing template

Ctrl + Shift + F for replace:

  • Rust template -> with your project name
  • template-exercisme -> with your rust project name
  • Exercism-Rust-Template -> with your GitHub repository name
  • rust-template -> with your Bencher project name
  • MathieuSoysal -> with your GitHub username
  • 2024 -> with the current year
  • Rust template that contains automatic benchmarking, automatic mutation testing, automatic fuzz testing. -> with your project description

Secrets

  • Add BENCHER_API_KEY in your repository secrets
  • Add CODECOV_TOKEN in your repository secrets
  • Add CARGO_REGISTRY_TOKEN in your repository secrets

🚀 Installation

MacOS Install the latest version for your system:
curl -sS https://raw.githubusercontent.com/MathieuSoysal/Exercisme-Rust-Template/main/install/install.sh | sh
Linux

Install the latest version for your system:

curl -sS https://raw.githubusercontent.com/MathieuSoysal/Exercisme-Rust-Template/main/install/install.sh | sh
Windows

Install the latest version for your system: Install

🤝 Contributing

We are always looking for contributors of all skill levels! If you're looking to ease your way into the project, try out a good first issue.

If you are interested in helping contribute to Rust template, don't hesitate to create your issue Create new Issue.

### 🚀 Quick start contributing

Quick start contributing you just need to click to this link Start Online Devcontainer to automatically create a development environment for this project and start contributing ;) and you can also read the CONTRIBUTING.md

📝 License

Copyright © 2019-present, Rust template Contributors.
This project is ISC licensed.

⭐️ Support project

If you like this project, feel free to support it by clicking on the ⭐️ button.