Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

47 lines (31 loc) · 2.6 KB

交流方式

本项目主要使用 Issue 与 Bearychat 进行交流沟通。Berrychat 的团队名为 CTF-Wiki,欢迎申请加入(申请时请注明申请理由)。

贡献方式

基本协作方式如下

  1. Fork 主仓库到自己的仓库中。
  2. 当你想要贡献某部分内容时,请你务必仔细查看 IssueProject 中的看板,以便确定是否有人已经开始了这项工作。当然,我们更希望你可以加入 Berrychat 中的 CTF-Wiki 团队,以便于沟通与交流。
  3. 在决定将内容推送到本仓库时,请你首先拉取本仓库代码进行合并,自行处理好可能出现的冲突,同时确保在本地可以正常生成文档,然后再将分支 PR 到主仓库的 master 分支上。其中,PR 需要包含以下基本信息
    • 标题:本次 PR 的目的(做了什么工作,修复了什么问题)
    • 内容:如果必要的话,请给出对修复问题的叙述
  4. PR 评论区进行评论,如果发现PR中有什么问题,请直接指出来并尽量给出修正的方式,或者也可以直接进行修改。
  5. 提出该 PR 的人根据评论修正内容,然后将修改后的内容 Merge 到 master 分支中。

目前,在人员较少的前提下,基本上可以忽略 4-5 步。第 2 步也可以暂时忽略。

贡献文档要求

当你打算贡献某部分的内容时,你应该尽量确保

  • 文档内容满足基本格式要求
  • 文档的合理性
  • 文档存储的格式

文档内容的基本格式

这里主要是指 中文排版指南Sphinx 编写方式

文档的合理性

所谓合理性,指所编写的 内容 必须具有如下的特性

  • 由浅入深,内容的难度应该具有渐进性。
  • 逻辑性,对于每类内容的撰写应该尽量包含以下的内容
    • 原理,说明该内容对应的原理。
    • 例子,给出1~2个典型的例子。
    • 题目,在该标题下, 只需要给出题目名字,相应的题目应该存储在 ctf-challenge 仓库中的对应目录中。

文档存储的格式

对于每类要编写的内容,对应的文档应该存储在合适的目录下

  • example,存储文档介绍时所使用的例子,请将每个例子在example下专门建立一个文件夹。
  • figure, 存储文档介绍时所使用的图片。
  • 文件名请务必都小写,以 _ 分割, 如 file_name