Merge pull request #24 from farm-fe/feat/contribution

chore: contribution

Author: ErKeLost

.cspell.json

@@ -1,3 +1,4 @@
 {
-    "ignoreWords": ["farmfe", "farmup", "execa", "shulandmimi"]
+    "ignoreWords": ["farmfe", "farmup", "execa", "shulandmimi", "biomejs"],
+    "ignorePaths": ["./pnpm-lock.yaml", "LICENSE", "CHANGELOG.md"]
 }

CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contributing
+
+## Local Development
+
+```shell
+# 1. install dependents
+pnpm install
+
+# 2. build source
+pnpm run build
+
+# 3. local development
+# start watch mode for build source
+pnpm run farmup
+
+# 4. link to global, use in other somewhere
+pnpm link --global
+
+# 5. test your change
+farmup file.ts
+```
+
+## Ready PR
+
+<!-- TODO: add lint in CI -->
+
+1. lint or other check
+
+```shell
+pnpm run ready
+```
+
+2. run changeset
+3. select changed package e.g farmup
+4. select an appropriate version number, e.g `patch`
+
+```shell
+npx changeset
+```
+
+## Create PR
+
+create PR in github and add reviewer for your PR

package.json

@@ -13,12 +13,15 @@
     "build": "farm build",
     "preview": "farm preview",
     "clean": "farm clean",
-    "release": "pnpm run build && changeset publish"
+    "release": "pnpm run build && changeset publish",
+    "farmup": "node ./bin/farmup.js --no-exec -w",
+    "ready": "node ./bin/farmup.js ./scripts/ready.ts -o ./dist/ready --no-config"
   },
   "bin": {
     "farmup": "./bin/farmup.js"
   },
   "devDependencies": {
+    "@biomejs/biome": "^1.7.3",
     "@farmfe/cli": "^1.0.2",
     "@types/fs-extra": "^11.0.4",
     "@types/lodash-es": "^4.17.12",
@@ -47,6 +50,7 @@
     "@changesets/cli": "^2.27.3",
     "@farmfe/core": "^1.1.12",
     "cac": "^6.7.14",
+    "cspell": "^8.8.3",
     "fs-extra": "^11.2.0",
     "glob": "^10.3.15",
     "lodash-es": "^4.17.21",
@@ -58,4 +62,4 @@
     "README.md",
     "bin"
   ]
-}
+}