From bdc10cacef6ef4a5d48de8c4c33dbdb1126f9d71 Mon Sep 17 00:00:00 2001 From: unleashit Date: Tue, 15 Apr 2025 14:38:37 -0700 Subject: [PATCH] docs(contributing): recommendations to use biome IDE addons and nvm for node version - emphasis added since using later versions of Node cause errors in the terminal - since the project uses biome but most IDEs have eslint/prettier addons, this tip will avoid commit/build suprises --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 015095aa..52fd7f2f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -52,7 +52,7 @@ feat: add new feature Before you start, please make the clone based on the `canary` branch, since the `main` branch is the source of truth and should always reflect the latest stable release, also the PRs will be merged to the `canary` branch. -We use Node v20.9.0 +We use Node v20.9.0 and recommend this specific version. If you have nvm installed, you can run `nvm install 20.9.0 && nvm use` in the root directory. ```bash git clone https://github.com/dokploy/dokploy.git @@ -87,6 +87,8 @@ pnpm run dokploy:dev Go to http://localhost:3000 to see the development server +Note: this project uses Biome. If your editor is configured to use another formatter such as Prettier, it's recommended to either change it to use Biome or turn it off. + ## Build ```bash