xazukx/ts-rs
1
0
Fork 0
mirror of https://github.com/xazukx/ts-rs.git synced 2026-08-23 12:58:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source 
This should help people make commits without forgetting to run `cargo +nightly fmt`
This commit is contained in:
escritorio-gustavo
2024-03-20 11:03:48 -03:00
committed by GitHub
parent 2000e8c83f
commit 73621cb490
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.md
View File

@@ -22,4 +22,11 @@ There is nothing special going on here - just run `cargo build`.
To run the test suite, just run `cargo test` in the root directory.
### Formatting
To ensure proper formatting, please run `cargo +nightly fmt`.
To ensure proper formatting, please make sure you have the nigthly toolchain installed.
After that, in the project's root directory, create a file called `.git/hooks/pre-commit` without a file extension and add the following two lines:
```sh
#!/bin/sh
cargo +nightly fmt
```
This will make sure your files are formatted before your commit is sent, so you don't have to manually run `cargo +nightly fmt`