diff --git a/.vscode/settings.json b/.vscode/settings.json index 3dc2ab9c..47a3060e 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -6,5 +6,15 @@ "source.fixAll.eslint": "explicit" }, "editor.defaultFormatter": "esbenp.prettier-vscode", - "editor.formatOnSave": true + "editor.formatOnSave": true, + "go.useLanguageServer": true, + "gopls": { + "formatting.gofumpt": true, + }, + "[go]": { + "editor.defaultFormatter": "golang.go" + }, + "[typescript]": { + "editor.defaultFormatter": "esbenp.prettier-vscode" + } } \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 66b8aff2..ee425a10 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,6 +28,7 @@ git clone https://github.com/your_username/certimate.git 1. 进入根目录 2. 运行以下命令启动服务: + ```bash go run main.go serve ``` @@ -36,11 +37,12 @@ git clone https://github.com/your_username/certimate.git **在向主仓库提交 PR 之前,建议你:** +- 使用 [gofumpt](https://github.com/mvdan/gofumpt) 对你的代码进行格式化。 + - 为你的改动添加单元测试或集成测试(Certimate 使用 Go 的标准 `testing` 包)。你可以通过以下命令运行测试(在项目根目录下): ```bash go test ./... - ``` ## 修改管理页面 (Admin UI) @@ -49,9 +51,12 @@ Certimate 的管理页面是一个基于 React 和 Vite 构建的单页应用( 要启动 Admin UI: -1. 进入 `ui` 项目目录 -2. 运行 `npm install` 安装依赖 +1. 进入 `ui` 项目目录。 + +2. 运行 `npm install` 安装依赖。 + 3. 启动 Vite 开发服务器: + ```bash npm run dev ``` diff --git a/CONTRIBUTING_EN.md b/CONTRIBUTING_EN.md index c29ba51c..3d848ec8 100644 --- a/CONTRIBUTING_EN.md +++ b/CONTRIBUTING_EN.md @@ -27,7 +27,9 @@ git clone https://github.com/your_username/certimate.git Once you have made changes to the Go code in Certimate, follow these steps to run the project: 1. Navigate to the root directory. + 2. Start the service by running: + ```bash go run main.go serve ``` @@ -36,6 +38,8 @@ This will start a web server at `http://localhost:8090` using the prebuilt Admin **Before submitting a PR to the main repository, consider:** +- Format your source code by using [gofumpt](https://github.com/mvdan/gofumpt). + - Adding unit or integration tests for your changes. Certimate uses Go’s standard `testing` package. You can run tests using the following command (while in the root project directory): ```bash @@ -49,11 +53,15 @@ Certimate’s Admin UI is a single-page application (SPA) built using React and To start the Admin UI: 1. Navigate to the `ui` project directory. + 2. Install the necessary dependencies by running: + ```bash npm install ``` + 3. Start the Vite development server: + ```bash npm run dev ```