Skip to content
This repository has been archived by the owner on May 19, 2022. It is now read-only.

Latest commit

 

History

History
31 lines (31 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

31 lines (31 loc) · 2.67 KB

LFS Book 协作规范

  • 「LFS Book」翻译项目使用 GitHub 进行仓库维护。
  • 中心代码仓库 LCTT/LFS-BOOK 仅允许翻译小组成员进行直接 Push,对于其他贡献者请参考下面的流程创建分支、作出修改、然后发出 Pull Request 以供审核。

初始化工作环境

  1. Fork 中心代码仓库 LCTT/LFS-BOOK
  2. 使用任意类 Unix 系统(如 Linux、OS X)$ git clone <自己的代码仓库>
  3. $ git remote add upstream git@github.com:LCTT/LFS-BOOK.git

推送提交流程

对于小组成员请直接修改后 Push,对于其他贡献者请参考以下流程:

注意:LFS 的翻译流程与 TranslateProject 的流程是不一样的,不一样的,不一样的。 翻译之前不要在认领文章开头添加任何信息。你可以通过修改 README.md当前任务,或是开 issue,或是 QQ 来通知其他成员。

  1. Pull 自己的对应翻译分支到上游最新版本。
  2. 切换到当前翻译分支:$ git checkout <当前翻译分支>
  3. Pull 上游翻译分支:$ git pull upstream <当前翻译分支>
  4. 创建新的分支 $ git checkout -b <分支名> <当前翻译分支>
  • 注意:分支名尽量有意义,并使用 - 连接小写英文单词和数字组合作为名称,例如:translate-chapter-1fix-typo-chapter-3-section-1
  1. Commit 更改:执行 git commit 并编写 Commit 信息。
  1. Push 分支:执行 git push -u origin <分支名> 以发布 Commit 的更改到自己的代码仓库。
  2. 登录 GitHub 发起 PR 并等待审核。

警告:请不要在本地编辑原文分支或翻译分支以及 master 以防止 PR 无法自动 merge。 注意:请在 PR 前在本地确保没有错字、书写风格或翻译错误,以加速审核。 提示:请配置 git 中作者的名称和邮箱以加入贡献列表当中。

文档风格

  1. 开始之前请务必先了解 统一文档风格,以便形成统一的文档风格。
  2. <para></para> 中的内容不要添加换行符。(注:英文原文有的情况,翻译的时候要去掉。)
  3. <seg></seg> 中的内容的格式不要变更
  4. <screen></screen> 中的内容不要更改
  5. 译者注是一件很严肃的事情,不要擅自添加

术语表

TODO