From 0a51fa434d18cf2e71b796a09e01e493649b0e9f Mon Sep 17 00:00:00 2001 From: Aoran Zeng Date: Fri, 27 Dec 2024 18:28:24 +0800 Subject: [PATCH] Add doc introduction --- doc/README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 doc/README.md diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000..8560f94 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,28 @@ + + +# 文档说明 + +E2E (End-to-End) 开发流程: + +1. 开发环境准备,如何编译和测试,请参考 [./Develop.md](./Develop.md) +2. 如何编写一个具体的 recipe,请参考 [./Write-A-Recipe-Even-If-You-Dont-Know-C.md](./Write-A-Recipe-Even-If-You-Dont-Know-C.md) +3. 直接推送还是提交 PR,请参考 [./CONTRIBUTING.md](./CONTRIBUTING.md) +4. 找谁来审阅 PR,请参考 [./MAINTAINERS.md](./MAINTAINERS.md) + +
+ +## 贡献指导 + +若有任何问题,可在 [GitHub discussions](https://github.com/RubyMetric/chsrc/discussions) 中询问和讨论 + +