From 77d27dba8e8bb7ba6c5708f890463635f1f8d07a Mon Sep 17 00:00:00 2001 From: Rex Zhang Date: Fri, 14 Jun 2024 16:21:05 +0800 Subject: [PATCH] Update contributing document --- docs/contributing.en.md | 33 ++++++++++++++++++++------------- 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/docs/contributing.en.md b/docs/contributing.en.md index 6de126ea..b04a1c92 100644 --- a/docs/contributing.en.md +++ b/docs/contributing.en.md @@ -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 @@ -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