From d10a446cdd16fed4360fbc8ec9ea33ddb49184dc Mon Sep 17 00:00:00 2001 From: kolaente Date: Thu, 8 Feb 2024 14:45:55 +0100 Subject: [PATCH] docs: update contribution guidelines --- docs/content/doc/development/development.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/content/doc/development/development.md b/docs/content/doc/development/development.md index 8f0aa3c4f..0993f758c 100644 --- a/docs/content/doc/development/development.md +++ b/docs/content/doc/development/development.md @@ -24,9 +24,9 @@ A maintainer will take a look and give you feedback. Once everyone is happy, the If you plan to do a bigger change, it is better to open an issue for discussion first. -## API +The main repo is [`vikunja/vikunja`](https://kolaente.dev/vikunja/vikunja), it contains all code for the api, frontend and desktop applications. -The code for the api is located at [code.vikunja.io/api](https://code.vikunja.io/api). +## API You'll need at least Go 1.21 to build Vikunja's api. @@ -37,10 +37,10 @@ Make sure to check the other doc articles for specific development tasks like [t ## Frontend requirements -The code for the frontend is located at [code.vikunja.io/frontend](https://code.vikunja.io/frontend). +The code for the frontend is located in the `frontend` sub folder of the main repo. More instructions can be found in the repo's README. -You need to have [pnpm](https://pnpm.io/) and Node.JS in version 18 or higher installed. +You need to have [pnpm](https://pnpm.io/) and Node.JS in version 20 or higher installed. ## Pull Requests @@ -92,6 +92,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 simplify generating release notes a lot. -It is not required to use them when creating a PR, but appreciated. \ No newline at end of file +It is not required to use them when creating a PR, but appreciated.