This is an automated email from the ASF dual-hosted git repository.
shuai pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/answer-website.git
The following commit(s) were added to refs/heads/main by this push:
new 85103dabd fix: update ui lint docs (#310)
85103dabd is described below
commit 85103dabdbe2179ec54546de374aae7edfd96428
Author: dashuai <[email protected]>
AuthorDate: Tue Mar 25 17:28:02 2025 +0800
fix: update ui lint docs (#310)
---
docs/development/guide.md | 4 +++-
.../zh-CN/docusaurus-plugin-content-docs/current/development/guide.md | 4 +++-
2 files changed, 6 insertions(+), 2 deletions(-)
diff --git a/docs/development/guide.md b/docs/development/guide.md
index 78f61b16a..4bce2c9cc 100644
--- a/docs/development/guide.md
+++ b/docs/development/guide.md
@@ -16,6 +16,8 @@ This guide will help you get started with the development of
the project.
```shell
cd ./ui
pnpm install
+ // This command will help you create the tools you need for good front-end
code validation to ensure that the code style
+ pnpm setup-lint
```
3. To start a development server, run `pnpm start`. now, your browser should
already open automatically, and autoload `http://localhost:3000`. you can also
manually visit it.
@@ -24,7 +26,7 @@ This guide will help you get started with the development of
the project.
### Code conventions
- **Most important: Look around.** Match the style you see used in the rest of
the project. This includes formatting, naming files, naming things in code,
naming things in documentation, etc.
-- We do have Prettier (a formatter) and ESLint (a syntax linter) to catch most
stylistic problems. If you are working locally, you can run `pnpm lint` and
`pnpm prettier` to fix most code formatting.
+- We do have Prettier (a formatter) and ESLint (a syntax linter) to catch most
stylistic problems. If you are working locally, you can run `pnpm setup-lint`,
which will help you initialize your `husky` and `pre-commit` files, which will
automatically help you check your commits during the commit phase. Or just run
`pnpm lint` and `pnpm prettier` to fix most code formatting.
- **No runtime errors** Before submitting the code, please ensure that there
will be no errors when running locally. This will greatly reduce the workload
of review.
<details>
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/guide.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/guide.md
index 78f61b16a..4bce2c9cc 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/guide.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/guide.md
@@ -16,6 +16,8 @@ This guide will help you get started with the development of
the project.
```shell
cd ./ui
pnpm install
+ // This command will help you create the tools you need for good front-end
code validation to ensure that the code style
+ pnpm setup-lint
```
3. To start a development server, run `pnpm start`. now, your browser should
already open automatically, and autoload `http://localhost:3000`. you can also
manually visit it.
@@ -24,7 +26,7 @@ This guide will help you get started with the development of
the project.
### Code conventions
- **Most important: Look around.** Match the style you see used in the rest of
the project. This includes formatting, naming files, naming things in code,
naming things in documentation, etc.
-- We do have Prettier (a formatter) and ESLint (a syntax linter) to catch most
stylistic problems. If you are working locally, you can run `pnpm lint` and
`pnpm prettier` to fix most code formatting.
+- We do have Prettier (a formatter) and ESLint (a syntax linter) to catch most
stylistic problems. If you are working locally, you can run `pnpm setup-lint`,
which will help you initialize your `husky` and `pre-commit` files, which will
automatically help you check your commits during the commit phase. Or just run
`pnpm lint` and `pnpm prettier` to fix most code formatting.
- **No runtime errors** Before submitting the code, please ensure that there
will be no errors when running locally. This will greatly reduce the workload
of review.
<details>
