ami/tl-vikunja
1
0
Fork 0
Code Activity

feat(docs): document pnpm (#1251)

Browse Source 
Co-authored-by: Dominik Pschenitschni <mail@celement.de>
Reviewed-on: https://kolaente.dev/vikunja/api/pulls/1251
Co-authored-by: Dominik Pschenitschni <dpschen@noreply.kolaente.de>
Co-committed-by: Dominik Pschenitschni <dpschen@noreply.kolaente.de>
This commit is contained in:
Dominik Pschenitschni
2022-10-01 15:30:20 +00:00
committed by konrad
parent 53419180be
commit 36265fcedf
3 changed files with 10 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/content/doc/development/development.md
View File

@ -1,5 +1,5 @@
---
date: "2019-02-12:00:00+02:00"
date: "2022-09-21:00:00+02:00"
title: "Development"
toc: true
draft: false
@ -42,8 +42,7 @@ You need to have [pnpm](https://pnpm.io/) and nodejs in version 16 or 18 install
## Git flow
The `main` branch is the latest and bleeding edge branch with all changes. Unstable releases are automatically
created from this branch.
The `main` branch is the latest and bleeding edge branch with all changes. Unstable releases are automatically created from this branch.
A release gets tagged from the main branch with the version name as tag name.
@ -51,7 +50,6 @@ Backports and point-releases should go to a `release/version` branch, based on t
## Conventional commits
We're using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) because they greatly simplify
generating release notes.
We're using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) because they greatly simplify generating release notes.
It is not required to use them when creating a PR, but appreciated.

4
docs/content/doc/development/test.md
View File

@ -98,12 +98,12 @@ Check out the docs [in the frontend repo](https://kolaente.dev/vikunja/frontend/
To run the frontend unit tests, run
{{< highlight bash >}}
pnpm test:unit
pnpm run test:unit
{{< /highlight >}}
The frontend also has a watcher available that re-runs all unit tests every time you change something.
To use it, simply run
{{< highlight bash >}}
pnpm test:unit-watch
pnpm run test:unit-watch
{{< /highlight >}}