GithubHelp home page GithubHelp logo

协作指引 about docs-next-zh-cn HOT 7 CLOSED

vuejs avatar vuejs commented on April 27, 2024
协作指引

from docs-next-zh-cn.

Comments (7)

Jinjiang avatar Jinjiang commented on April 27, 2024 1

几点个人建议:

仓库协作须知汇总:建议整理到 wiki

贡献者汇总:建议不必手动整理,可以直接看 contribution 页面 https://github.com/vuejs/docs-next-zh-cn/graphs/contributors

记录存在有争议的翻译:我个人不建议设长周期的 issue,建议每个 issue 讨论一个译法,讨论有结论之后就关掉并整理到 wiki,理由:

  1. 避免引导重复讨论。
  2. issue 不适合做信息积累,信息积累交给 wiki 比较好
  3. issue 应该存放一些我们应该及时解决掉的问题,相对都是短周期的

Project board 不能开放社区编辑,所以建议:

  • 对于尚未翻译的内容
    1. 在 issue 里发起认领翻译,我们看到之后整理到 project board (移动到正在翻译,并注明认领人)
    2. 翻译完毕后,创建 PR,我们看到之后整理到 project board (移动到已翻译待校对)
    • 社区发起的 PR 没有权限指定 reviewer 所以也就不必了,这个我们自己来处理就好了,大家没有被指定为 reviewer 也是可以对 PR 进行逐行评论的,所以问题不大
    1. 超过社区 2 人或我们团队成员校对并 approve 之后,我们合并分支并整理到 project board (移动到已完成)
    2. 关闭最早创建的 issue
  • 对于已经翻译但尚未校对的内容
    1. 在 issue 里发起认领校对,我们看到之后整理到 project board (移动到已翻译待校对,并注明认领人)
    2. 校对完毕后,创建 PR,同理这里不需要指定 reviewer
    3. 我们团队成员进行校对和合并分支,并整理到 project board (移动到已完成)
    4. 关闭最早创建的 issue

除了翻译和校对

  • 定期同步最新的翻译:颗粒度 (所以更新、某个页面或某个细节) 可以自选,可以直接发起 PR
  • 非文档内容的代码同步:涉及比较细节的仓库结构和实现,一般会由团队自行发起 PR 并完成
  • 网络环境和本地化:如果发现任何这方面的问题可以直接发起 issue 讨论
  • 翻译讨论:可以随时发起 issue 讨论

哪些讨论建议去英文版讨论

  • 对于原文内容的讨论,而非中文译法本身
  • 对于网站代码的优化,除非是特别针对中文站或国内环境的

哪些讨论原则上这里不受理

  • 对于 Vue 的使用答疑,请移步到各大技术社区讨论

from docs-next-zh-cn.

Jinjiang avatar Jinjiang commented on April 27, 2024 1

好建议。我加入了 翻译、校对、从英文版同步 三个 label,应该够了,对在 issue 认领和提交 PR 都是通用的

from docs-next-zh-cn.

veaba avatar veaba commented on April 27, 2024

占楼1

from docs-next-zh-cn.

veaba avatar veaba commented on April 27, 2024

占楼2

from docs-next-zh-cn.

veaba avatar veaba commented on April 27, 2024

占楼3

from docs-next-zh-cn.

veaba avatar veaba commented on April 27, 2024

占楼4

from docs-next-zh-cn.

veaba avatar veaba commented on April 27, 2024

@Jinjiang 是不是需要在 issue 中新增几个 label 用于标注 翻译、认领、校对 issue?
如翻译进度 project:未翻译正在翻译已翻译校对已完成

from docs-next-zh-cn.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.