MountainTownTechnology
/
aural_isle
4
1
Fork 1
Code Issues 20 Pull Requests 3 Packages Projects 1 Releases Wiki Activity

WIP: add formatting doc and pre-commit #7

Draft
enot wants to merge 3 commits from docs-formatting into main
pull from: docs-formatting
merge into: MountainTownTechnology:main
Conversation 1 Commits 3 Files Changed 2 +2 -2
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 136da63d00 - Show all commits

4
CONTRIBUTING.md
View File

@ -12,7 +12,7 @@ To check if your code is formatted without making changes, run `cargo fmt --chec
### VScode ### VScode
We recommend the meta extension Rust, which includes rust-analyzer. Then to set your editor to format on save: We recommend the meta extension [Rust Bundle](https://marketplace.visualstudio.com/items?itemName=1YiB.rust-bundle) , which includes rust-analyzer. ([More info](https://code.visualstudio.com/docs/languages/rust) on Rust with VScode) Then to set your editor to format on save:
* In Visual Studio Code, press Control + Shift + P or Command + Shift + P (Mac) to open the command palette and type setting and then select Preferences: Open User Settings option. * In Visual Studio Code, press Control + Shift + P or Command + Shift + P (Mac) to open the command palette and type setting and then select Preferences: Open User Settings option.
* Search for format on save setting and check the checkbox. * Search for format on save setting and check the checkbox.
@ -27,4 +27,4 @@ You will first need to [install rust-analyzer](https://rust-analyzer.github.io/m
If you want to think about formatting your code less and just have git yell at you whe you try to commit code that is not properly formatted, you can use a simple pre-commit hook. If you want to think about formatting your code less and just have git yell at you whe you try to commit code that is not properly formatted, you can use a simple pre-commit hook.
After cloning the repo, the file `pre-commit` to `.git/hooks/pre-commit`. That's it. After cloning the repo, move the file `pre-commit` to `.git/hooks/pre-commit`. That's it.