A template for creating Rust
project for FST Network
.
- Make FST Network great!
- Сделайте FST Network отличным!
.github
contains GitHub Actions related definition.dev-support
contains development utilitiesdev-support/bin
contains tools which will be used through development processdev-support/ci-bin
contains scripts used by GitHub Actionsdev-support/containers
contains the container related definitionsdev-support/nix-overlay
contains overrides to Nix channel or custom derivations
It is suggested to install git hook for style linting before code committing. This project is configured with pre-commit.
Installation steps:
pre-commit install --install-hooks -t commit-msg -t pre-commit
There are some useful commands just like the one in Rust
toolchain but with proper arguments:
cargo build-all
cargo clippy-all
cargo test-all
cargo doc-all
cargo miri-all
cargo watch-all
(ex.cargo watch-all clippy
)
Please perform the following steps before submitting Pull Request:
It is suggested to perform the following steps before submitting Pull Request:
- Run codespell to find out common misspellings
- Run format-check to check format of
Rust
,Shell
,Nix
,JavaScript
,TypeScript
,Markdown
,JSON
,YAML
- Run cargo clippy-all to lint common mistakes of
Rust
- Run cargo test-all to perform tests
- Run udeps to check unused dependencies
Other tools:
- generate-changelog: Generate from commit messages
- install-deps: Install saffron dependencies
- format-all: format all files
- format-rust: format
*.rs
files - format-sql: format
*.sql
files - lines-of-code: Count lines of code in this project