mirror of
https://github.com/morgan9e/warehouse
synced 2026-04-14 00:04:08 +09:00
Add pre-commit scripts for file formatting
This commit is contained in:
15
README.md
15
README.md
@@ -56,3 +56,18 @@ You're all set! Launch the application by clicking its icon in your app menu or
|
||||
```shell
|
||||
flatpak run io.github.flattool.Warehouse
|
||||
```
|
||||
|
||||
## 👥 Contributing
|
||||
|
||||
### Compiling from Source
|
||||
|
||||
TODO
|
||||
|
||||
### Formatting
|
||||
|
||||
Warehouse uses [pre-commit](https://pre-commit.com/) for code formatting.
|
||||
- Install using `pip install pre-commit`
|
||||
- Run `pre-commit install` in the Warehouse repository root to set up pre-commit for this repo.
|
||||
- Run `pre-commit run --all-files` to format all files in the repository.
|
||||
|
||||
If you run into a situation where pre-commit is broken, you can use `git commit --no-verfiy` to skip the pre-commit checks.
|
||||
|
||||
Reference in New Issue
Block a user