Skip to content

Commit

Permalink
docs: build.zh.md, lint.zh.md chinese version
Browse files Browse the repository at this point in the history
Signed-off-by: wendao <1374968273@qq.com>
  • Loading branch information
wendao365 committed Jun 24, 2022
1 parent c24b478 commit c82517c
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 2 deletions.
16 changes: 16 additions & 0 deletions docs/development/build.zh.md
Original file line number Diff line number Diff line change
@@ -1 +1,17 @@
# 构建

```shell
cd path/to/devstream
make clean
make build -j8 # 多线程构建
```

上述命令将构建所有内容: `dtm` 本身及所有插件。

项目也支持以下构建模式:

- 只构建 `dtm``make build-core`
- 构建指定的插件:`make build-plugin.PLUGIN_NAME`。例如: `make build-plugin.argocd`
- 构建所有插件:`make build-plugins -j8` (多线程构建)。

使用 `make help` 获取更多信息。
16 changes: 14 additions & 2 deletions docs/development/lint.zh.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
# Lint
# 代码检查

todo

项目使用Go 的代码检查工具集`golangci-lint` ([official website](https://golangci-lint.run/), [GitHub](https://github.com/golangci/golangci-lint)) 进行代码格式检查。

也支持与 Github 工作流集成。

- 记录默认启用的检查项的 [文档](https://golangci-lint.run/usage/linters/)
- 也可以和 [IDE](https://golangci-lint.run/usage/integrations/) 集成。
- 也可以在 [本地运行](https://golangci-lint.run/usage/quick-start/)

除此之外,我们使用 [Go Report Card](https://goreportcard.com/report/github.com/devstream-io/devstream) ,为你的开源 Go 代码生成质量报告。

在项目的README.md中,有代码质量标志 [![Go Report Card](https://goreportcard.com/badge/github.com/devstream-io/devstream)](https://goreportcard.com/report/github.com/devstream-io/devstream)

0 comments on commit c82517c

Please sign in to comment.