Skip to content

websterzh/vatprc-wiki

Repository files navigation

VATPRC Wiki

本项目旨在更新并整合 VATPRC 现有的各种教程,此仓库仅为雏形,最终大致会以一个知识库的方式集中展现。该内容面向的对象为新手,针对“快餐化”的流行趋势,在包含对内容详细解释的同时,也可适当加入一些简单概括性的内容。项目使用众包机制,任何有经验的 VATPRC 成员都可以根据目录中的内容编写对应部分的教程,并通过 Pull Request 将他们的内容合并到本仓库中。

编写要求

  • 使用 Markdown 语法
  • 每个文件均使用 .md 的后缀保存,文件名应与文章标题保持一致
  • 每个文章应有对应的单个文件夹
  • 图片可使用外链,也可以放在文章所在文件夹的 images/ 目录下
  • 目录结构与文件结构对应
    • wiki中 新手入门 -> 连接到VATSIM网络 -> X-Plane 对应仓库master分支下的 新手入门/连接到VATSIM网络/X-Plane/如何使用 X-Plane 连飞.md 文章使用的图片存储在 新手入门/连接到VATSIM网络/X-Plane/images

注意!未按照上述要求编写的Pull Request将会被拒绝!

注意事项

  • 需要编写的内容和各内容的状态参见本仓库的 Issues 和目录
    • 如果想到了新的想要编写的内容,可以开新的Issue集思广益,也可以编写好后提交PR
    • 对于Issue内的新内容,将会开新分支进行编辑
    • 对于自行编写的新内容或修改已有的内容,Fork后在自己的仓库内编辑即可,编辑完成后提交PR即可
  • 编写前请先思考编写此章节的目的,是为了帮助新手快速入门还是详细的概念或定义
    • 快速入门:尽可能的表述清楚操作过程,晦涩难懂的定义可以一笔带过或附上链接
    • 概念和定义:尽可能完整,详细,系统地编写
  • 不要让内容在本地过夜,尽可能实时地提交你的修改,保证其他人可以看到实时的版本
    • 正确:每编写一个有意义的小节后提交一次
    • 正确:小节内容较多,每编写一小部分后提交一次
    • 正确:需要修改现有内容中出现的错字,修改后提交一次
    • 错误:每写三个字提交一次
    • 错误:每写一句话提交一次
    • 错误:用几天的时间在本地编写一大堆内容然后一次性提交
  • 不建议从现有的教程中复制粘贴内容,尽可能根据最新的现实情况重新编写
  • 优先编写工作量较小的话题,快速迭代补全内容
  • 编写话题时,不要使用大面积地使用加粗下划线,只在最有意义的地方添加加粗或下划线
  • 编写话题时,合理使用各层级的大小标题、

工作流程

注意:下方工作流程是直接使用 GitHub 网页版的工作流程,如果你使用命令行或其他工具,可酌情参考并根据自身情况调整。

新增Issue内的新话题

如果你想新编写的话题在Issue内且还没有分支,你需要按照以下方式开新分支:

  1. 按照编写要求新建文件夹并开始编写
  2. 修改完成后,在下方 Commit changes 中的标题处概括你本次修改的原因/大致内容
  3. 选择 Create a new branch for this commit and start a pull request.
  4. 在下方输入新的分支名字,通常是该主题的英文标题,使用横线 - 连接
  5. 提交后会出现新的分支和 Pull Request

修改话题

如果你的话题已经有分支正在修改,可切换至该分支后,进行下列步骤:

  1. 从该分支中找到你想要修改的文件,进入修改页面并开始修改
  2. 如果你需要新增文章,请按照编写要求新建文件夹并开始编写
  3. 修改完成后,在下方 Commit changes 中的标题处概括你本次修改的原因/大致内容
  4. 选择 Commit directly to the ***** branch.
  5. 提交

更新目录

更新 SUMMARY.md 文档即可更新目录。

Pull Request 处理流程

审核人员会定期处理现有的 Pull Request,提出改进意见或通过 Pull Request 将分支合并进入主分支。任何编写人员都可以在 Pull Request 下留言并且进行讨论。

Pull Request 被要求修改

  1. 不需要关闭 Pull Request 重新开,可直接修改文件并提交即可,新的提交会自动同步进 Pull Request 中
  2. 修改完成后,建议留言等待下一次审核

Pull Request 获得通过

  1. 通常分支会随着 Pull Request 通过而被删除
  2. 如果需要再次修改,请按照 第一次新增/修改话题 中的步骤开启新的 Pull Request。

下列情况可关闭 Pull Request

  1. 完全放弃,不再进行进一步修改
  2. 打算放弃该次修改,完全重新开始进行修改,在此情况下,可关闭 Pull Request 后按照 修改话题 中的步骤开启新 Pull Request

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published