Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 3.15 KB

翻译贡献须知.md

File metadata and controls

61 lines (40 loc) · 3.15 KB

若尚不熟悉GitHub的Fork和PR(Pull Request)概念及Git相关操作,请先学习之。

版权声明

英文原版遵循Julia社区选择的MIT开源协议;

凡贡献给朱华社区的译本均表示译者本人已放弃任何可能的权力。

风格说明

ReadMe中所透露的,此译本并不追求“发言人”般的正式用语;

凡是有利于读者理解的任何手法、凡是不违背江湖道义的手段,都可以!

一些防止枯燥的小玩笑被认为是优秀实践,对,不求“才华横溢”,最好“妙趣横生”。

特别是针对“挨踢”从业者(或有意成为)气质量身定制的套路,尽管上。

仓库地址

JuliaDocCN

必须步骤

  • 给JuliaDocCN打星加油
  • 创建自己的JuliaDocCN仓库
  • 在自己的JuliaDocCN仓库创建一个翻译分支(如git branch manual/documentation
  • 在对应的路径创建中文译本Markdown文件(如手册目录下文档.md
  • 翻译完成检查无误则慷慨PR吧
  • 朱华社区负责Review的朋友检查无误即当合入(否则需要讨论并更正检视意见后合入)
  • 新的文档翻译应当确保返回主干并更新主干
    • 返回主干(git checkout master
    • 首先完成JulialangOrgCN的JuliaDocCN主干到自己的JuliaDocCN主干的PR以更新自己的JuliaDocCN仓库
    • 然后更新自己本地的主干(git pull
  • 继续上述三到六步骤提交新的文档翻译

可选步骤

根据姐夫必赞神之指导更正。

  • 创建自己的【Julia】仓库
  • 克隆自己的【Julia】仓库到本地
  • 默认在master分支(否则切换到此)在本地检出release-1.0分支(git checkout release-1.0
  • 在翻译的过程中若发现英文原版有问题
    • 给【Julia】提问题

    • 或者:

      创建一个补丁分支(如git branch v1.0/docs/manual/documentation

      切换到该新分支(git checkout v1.0/docs/manual/documentation

      更正问题(建议以一个单独文件为单位)

      推送到到自己的【Julia】仓库(git push --set-upstream origin v1.0/docs/manual/documentation

  • 将自己【Julia】仓库中的补丁分支(如v1.0/docs/manual/documentation)提交PR到master分支到Julia的release-1.0分支
  • 及时留意自己提交的PR对构建造成的影响及各类回应并恰当处置
  • 也要如“必须步骤”所述的“切回master分支”并更新到【Julia】的master分支也要如“必须步骤”所述的“切回release-1.0分支”并更新到【Julia】的release-1.0分支后继续

例程强调

翻译过程中如有必要将例程单独展示或有更优雅且一目了然或有趣的自造例程,可提交到howtojulia项目对应位置,切记命名呼应,基本步骤与JuliaDocCN贡献相似,不再赘述。