paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2026-01-28 22:59:03 -06:00
Code Issues Packages Projects Releases Wiki Activity

Development: update devcontainer setup, add documentation for pre-commit, set uv cache dir (#11882)

Browse Source
This commit is contained in:
Philipp Defner
2026-01-27 21:45:56 +01:00
committed by GitHub
parent 6d93ae93b4
commit 02002620d2
4 changed files with 51 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
.devcontainer/README.md
View File

@@ -89,6 +89,18 @@ Additional tasks are available for common maintenance operations:
- **Migrate Database**: To apply database migrations.
- **Create Superuser**: To create an admin user for the application.
## Committing from the Host Machine
The DevContainer automatically installs pre-commit hooks during setup. However, these hooks are configured for use inside the container.
If you want to commit changes from your host machine (outside the DevContainer), you need to set up pre-commit on your host. This installs it as a standalone tool.
```bash
uv tool install pre-commit && pre-commit install
```
After this, you can commit either from inside the DevContainer or from your host machine.
## Let's Get Started!
Follow the steps above to get your development environment up and running. Happy coding!