Skip to content

Latest commit

 

History

History
67 lines (53 loc) · 2.78 KB

contributing.md

File metadata and controls

67 lines (53 loc) · 2.78 KB

贡献指南

如何开发/测试

  1. 安装node14
  2. 安装yarn
  3. 克隆这个仓库 git@github.com:Snippetors/snippets.git
  4. cd snippets
  5. yarn install
  6. yarn dev

打开浏览器,访问 http://localhost:8080/

如何用docker测试

git clone git@github.com:Snippetors/snippets.git
cd snippets
docker build -t snippets .
docker run -it -p 8080:80 snippets

打开浏览器,访问 http://localhost:8080/

 主要工具版本

  1. node 14
  2. yarn
  3. vuepress 2

重要文件

  1. 主要配置、目录
  2. hello world 页面
  3. 代码片段库

模板添加流程

  1. 代码片段库中有四种语言的分类目录,Java用户请以gradle项目导入IDE,其他语言自不必多言
  2. 在相应位置添加代码,文件分组请遵循最终目录分组。例如杂项/hello页面应处于misc目录之下。从目录文件目录文件navbar部分也可以看出这样的分组情况。
  3. 在相应位置添加测试代码,同样,请依照各个hello测试文件
  4. 查看目录文件,如有必要,请添加/修改目录
  5. 查看相应位置的markdown文件,如hello.md,如有必要,请添加/修改。关于如何导入代码块,请参照文档。关于如何使用tabs插件,请查看文档 (但常规情况下,你不需要对该插件做任何其他设定)
  6. git操作规范
git pull -r main
git checkout -b feature_branch(请根据你添加的内容自己命名你的分支)
...添加修改
git add xxx
git commit
git push --set-upstream origin feature_branch
  1. 建立Pull Request
  2. GitHub Action 应该会自动跑起来,当检查失败时,请检查失败的原因(Test失败,或者代码格式不符)
  3. 当相应的代码审查者批准Pull Request后,你的分支将自动合并

测试框架

  1. C++ 使用GoogleTest
  2. Java 使用JUnit 5
  3. Python 使用Pytest
  4. Go 使用内置测试模块

代码风格检查

  1. C++ 使用cpplint
  2. Java 使用checkstyle,风格在Google风格上略有改动,详情请见配置文件
  3. Python 使用flake8
  4. Go 使用内置检查模块