Skip to content

eesast/docs

Repository files navigation

EESΛST Docs

All Contributors

Creative Commons License

使用 Docusaurus 2 构建,电子系科协以 CC-BY-SA 4.0 授权开放的一系列工具与框架的使用指南。

命令

安装依赖

yarn install

开发

yarn start

构建静态文件

yarn build

格式化和检查

本项目初步配置了 eslintprettier 用于进行检查和格式化。由于项目主体为文档,不强求使用。建议编辑后使用 yarn prettier 进行格式化。

参与贡献

我们欢迎所有人参与此项目,包括且不限于:Issue、Pull Request

Issue

Issue 用于提出问题、讨论功能改进、讨论文档内容改进等。提出 Issue 时,请务必检查以下几点:

  • Issue 标题是否有明确的意义
  • 是否已经有人提出了类似的 Issue

Pull Request

Pull Request 用于将贡献者的修改合并到本项目的主分支中。我们遵循 Fork & Pull 开发流程,即所有参与贡献者需:

  1. 总应 fork 本项目到个人仓库,如 duskmoon/docs
  2. 建立一个具有明确意义名字的分支,如 reactDoc
  3. 撰写文档(参照文件结构),每一个 commit 都应具有可读的信息,如 Add usage of useState() in react docs
  4. 提交一个具有明确意义标题的 Pull Request,如 Add react docs
  5. 等待通过 CI 并有仓库的维护人员接受
  6. 由 CI 或维护人员合并到主分支

对于 git 的使用,可以参看文档中相关部分。

贡献者 ✨

感谢诸位贡献者们 (emoji key):

Campbell He
Campbell He

💻 📖 🚇 🚧
Xiaoyang Ma
Xiaoyang Ma

📖
lyz
lyz

📖
Xiangyu Li
Xiangyu Li

📖
hukz18
hukz18

📖
Jun Zhang
Jun Zhang

📖
Bowman
Bowman

📖
DreamDraw Pan
DreamDraw Pan

📖
Yang-Xijie
Yang-Xijie

📖
Timothy Liu
Timothy Liu

📖 🚧 👀
Wang Zhiheng
Wang Zhiheng

📖
Roy Chen
Roy Chen

📖
Ther
Ther

📖
Bx
Bx

📖
TCL
TCL

📖
Boran Sun
Boran Sun

📖
PLUTO-SCY
PLUTO-SCY

📖
L0510410
L0510410

📖 💻 🚧
DragonAura
DragonAura

📖
Rosist Sallina
Rosist Sallina

📖
Xuc Pan
Xuc Pan

📖

This project follows the all-contributors specification. Contributions of any kind welcome!