github-mirror/chsrc
2
0
Fork 0
mirror of https://github.com/RubyMetric/chsrc.git synced 2025-01-23 12:02:02 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add doc introduction

Browse Source
This commit is contained in:
Aoran Zeng 2024-12-27 18:28:24 +08:00
parent 7dd4a0b028
commit 0a51fa434d
No known key found for this signature in database
GPG Key ID: 8F8BA8488E10ED98
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/README.md Normal file
View File

@ -0,0 +1,28 @@
<!-- -----------------------------------------------------------
! SPDX-License-Identifier: GFDL-1.3-or-later
! -------------------------------------------------------------
! Doc Type : Markdown
! Doc Name : (Document Introduction.md)
! Doc Authors : Aoran Zeng <ccmywish@qq.com>
! Contributors : Nul None <nul@none.org>
! |
! Created On : <2024-12-27>
! Last Modified : <2024-12-27>
! ---------------------------------------------------------- -->
# 文档说明
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)
<br>
## 贡献指导
若有任何问题，可在 [GitHub discussions](https://github.com/RubyMetric/chsrc/discussions) 中询问和讨论
<br>