使用 Docusaurus 2 构建,电子系科协以 CC-BY-SA 4.0 授权开放的一系列工具与框架的使用指南。
yarn install
yarn start
yarn build
本项目初步配置了 eslint
和 prettier
用于进行检查和格式化。由于项目主体为文档,不强求使用。建议编辑后使用 yarn prettier
进行格式化。
我们欢迎所有人参与此项目,包括且不限于:Issue、Pull Request
Issue 用于提出问题、讨论功能改进、讨论文档内容改进等。提出 Issue 时,请务必检查以下几点:
- Issue 标题是否有明确的意义
- 是否已经有人提出了类似的 Issue
Pull Request 用于将贡献者的修改合并到本项目的主分支中。我们遵循 Fork & Pull
开发流程,即所有参与贡献者需:
- 总应
fork
本项目到个人仓库,如duskmoon/docs
- 建立一个具有明确意义名字的分支,如
reactDoc
- 撰写文档(参照文件结构),每一个
commit
都应具有可读的信息,如Add usage of useState() in react docs
- 提交一个具有明确意义标题的 Pull Request,如
Add react docs
- 等待通过 CI 并有仓库的维护人员接受
- 由 CI 或维护人员合并到主分支
对于 git
的使用,可以参看文档中相关部分。
感谢诸位贡献者们 (emoji key):
Campbell He 💻 📖 🚇 🚧 |
Xiaoyang Ma 📖 |
lyz 📖 |
Xiangyu Li 📖 |
hukz18 📖 |
Jun Zhang 📖 |
Bowman 📖 |
DreamDraw Pan 📖 |
Yang-Xijie 📖 |
Liu Xuefeng 📖 |
This project follows the all-contributors specification. Contributions of any kind welcome!