docs: document how dependencies are handled
This commit is contained in:
parent
78945d03fa
commit
de8e806b28
4 changed files with 26 additions and 3 deletions
22
docs/dev/dependencies.md
Normal file
22
docs/dev/dependencies.md
Normal file
|
@ -0,0 +1,22 @@
|
||||||
|
# Packaging
|
||||||
|
|
||||||
|
The packaging is handled by the `pyproject.toml` file for python dependencies,
|
||||||
|
and by `package.json` for JavaScript dependencies.
|
||||||
|
|
||||||
|
## Python
|
||||||
|
|
||||||
|
Python dependencies are pinned, and we're relying on Github's dependabot to
|
||||||
|
update them for us, via pull requests.
|
||||||
|
|
||||||
|
## JavaScript
|
||||||
|
|
||||||
|
Dependencies are **not** pinned, but a `^` character is used instead ([defined
|
||||||
|
by node semver](https://github.com/npm/node-semver#caret-ranges-123-025-004)),
|
||||||
|
meaning the next minor or patch versions will be installed (but not the next major)
|
||||||
|
|
||||||
|
The installed libs needs to be:
|
||||||
|
|
||||||
|
- Added to the `package.json`
|
||||||
|
- Added in the `scripts/vendorsjs.sh` script
|
||||||
|
- Loaded in the HTML templates.
|
||||||
|
|
|
@ -7,9 +7,10 @@ nav:
|
||||||
- Getting started: install.md
|
- Getting started: install.md
|
||||||
- Contribute: contributing.md
|
- Contribute: contributing.md
|
||||||
- Release: release.md
|
- Release: release.md
|
||||||
- Architecture:
|
- Development:
|
||||||
- Overview: architecture/overview.md
|
- Overview: dev/overview.md
|
||||||
- Frontend: architecture/frontend.md
|
- Frontend: dev/frontend.md
|
||||||
|
- Dependencies: dev/dependencies.md
|
||||||
- Configuration:
|
- Configuration:
|
||||||
- Settings: config/settings.md
|
- Settings: config/settings.md
|
||||||
- Customize: config/customize.md
|
- Customize: config/customize.md
|
||||||
|
|
Loading…
Reference in a new issue