48 lines (33 loc) · 909 Bytes

Contributing

Prerequisites

Rust (stable toolchain)
A GH_TOKEN with repo access (for releases)

Getting Started

git clone https://github.com/urmzd/fsrc.git
cd fsrc
cargo build

Development

cargo build          # compile
cargo test           # run tests
cargo fmt            # format code
cargo clippy         # lint

Commit Convention

We use Angular Conventional Commits:

type(scope): description

Types: feat, fix, docs, refactor, test, chore, ci, perf

Use Conventional Commits format.

Pull Requests

Fork the repository
Create a feature branch (feat/my-feature)
Make changes and commit using conventional commits
Open a pull request against main

Code Style

cargo fmt for formatting
clippy for linting
No unsafe code