novaburst/funquail
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

docs: rearrange paths, update links and redirects

Browse source 
Part-of: <https://dev.funkwhale.audio/funkwhale/funkwhale/-/merge_requests/2353>
This commit is contained in:
Ciarán Ainsworth 2023-02-01 13:41:44 +01:00
commit 65316d43c1
169 changed files with 254 additions and 255 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/developer/workflows/pre-commit.md Normal file
View file

@ -0,0 +1,20 @@
# Pre-commit
Funkwhale uses [pre-commit](https://pre-commit.com/) to ensure that the files you commit are properly formatted, follow best practice, and don't contain syntax or spelling errors.
You can install and setup pre-commit using the [quick-start guide on the pre-commit documentation](https://pre-commit.com/#quick-start). Make sure to install pre-commit and setup the git pre-commit hook so pre-commit runs before you commit any changes to the repository.
The workflow looks like this:
1. Install `pre-commit`.
2. After cloning the repository, setup the pre-commit git hooks:
```sh
git clone git@dev.funkwhale.audio:funkwhale/funkwhale.git
cd funkwhale
pre-commit install
```
3. Make your changes and commit them.
4. If `pre-commit` fails to validate your changes, the commit process stops. Fix any reported errors and try again.