Skip to content

Commit

Permalink
Update contributing document
Browse files Browse the repository at this point in the history
  • Loading branch information
rexzhang committed Jun 14, 2024
1 parent 3fbbd1e commit 77d27db
Showing 1 changed file with 20 additions and 13 deletions.
33 changes: 20 additions & 13 deletions docs/contributing.en.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
# Contributing

New feature, bug fix, new language, new howto, typo fix; everything is fine.
New feature, bug fix, new language, new howto, typo fix; everything is fine.

!!! note
## workflow

issue -> discuss -> fork -> PR
issue -> fork -> PR Draft -> CI -> merge

- issue
- discuss of the technical solution
- PR Draft
- discuss of technical details
- review code
- check document

## Code

Expand Down Expand Up @@ -37,16 +44,16 @@ cp docs/index.en.md docs/index.ru.md
`mkdocs.txt` example

```yaml
languages:
en: English
ru: русский
zh: 中文
nav_translations:
zh:
Home: 首页
Setup: 配置
Reference: 资料
Trouble Shooting: 故障处理
languages:
en: English
ru: русский
zh: 中文
nav_translations:
zh:
Home: 首页
Setup: 配置
Reference: 资料
Trouble Shooting: 故障处理
```
#### Ref
Expand Down

0 comments on commit 77d27db

Please sign in to comment.