RabbitMQ 中文文档
使用说明:
贡献方式:
您可以:
-
将希望别人翻译的或者自己打算翻译的文章提交到这里
-
在source目录中创建Markdown格式的新文档,并在头部添加>原文:原文档地址以及>状态:待翻译
-
添加新文档后,pull request到本项目,等待贡献者翻译、校对
-
翻译source目录内尚未翻译完成的文章(翻译前请先认领文章)
-
认领目的:保证同一时间只有一人负责翻译,避免因个人习惯产生的风格冲突,避免重复劳动
-
认领方式:凡状态为待翻译的文章都可认领。将文章状态改为>状态:翻译中后pull request到本项目
-
开始翻译:您认领操作的pull request被合并进本项目后表示认领成功,可对其进行翻译
-
完成翻译后:请在文章头部添加>翻译:您的名字,并将状态改为>状态:待校对;然后将其移动到translated目录
-
对translated目录内所有已完成翻译的文档进行校对(提出关于内容质量,技术术语等的修缮建议)
-
完成校对后:请在文章头部添加>校对:您的名字,并将状态改为>状态:校对完成;之后将其移动到published目录。
-
文档的文件名请使用英文
-
发布到此处的文档请统一使用Markdown格式。
-
Markdown语法介绍可以点击此处查看。
-
Markdown编辑器推荐:
-
在线编辑器:Markable
-
本地编辑器:haroopress
-
创建并登录您的Github帐号
-
点击本项目右上角fork按钮,将本项目派生到您的帐号下
-
将您帐号下的派生clone到本地
git clone your_repo_address -
在本地的项目中新建一个branch,在此分支中进行您的工作
git branch new_branch_name -
将git切换到新建的branch
git chechout new_branch_name -
将本项目地址添加为远端对象
git remote add upstream https://github.com/mr-ping/RabbitMQ_into_Chinese.git -
获取远端更新
git fetch upstream master -
将远端更新合并到本地
git merge upstream/master
项目结构
source暂时存储尚未翻译或者完成部分翻译的文章
translated暂存翻译完成但尚未校对的文档
published目录存储已经完成校对的文章
文档格式:
Github流程:
其中1-6步只需执行一次,7&8步可多次执行