feat: add info about pre-commit to README
This commit is contained in:
parent
670d66210b
commit
3efad09123
1 changed files with 18 additions and 0 deletions
|
|
@ -771,6 +771,24 @@ readme_template = """### {app_title}
|
|||
|
||||
{app_description}
|
||||
|
||||
### Contributing
|
||||
|
||||
This app uses `pre-commit` for code formatting and linting. Please [install pre-commit](https://pre-commit.com/#installation) and enable it for this repository:
|
||||
|
||||
```bash
|
||||
cd apps/{app_name}
|
||||
pre-commit install
|
||||
```
|
||||
|
||||
Pre-commit is configured to use the following tools for checking and formatting your code:
|
||||
|
||||
- black
|
||||
- isort
|
||||
- flake8
|
||||
- eslint
|
||||
- prettier
|
||||
- pyupgrade
|
||||
|
||||
### License
|
||||
|
||||
{app_license}
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue