-
Notifications
You must be signed in to change notification settings - Fork 6
入伙指南
Palance edited this page Jul 16, 2016
·
20 revisions
"水果刀叉"分两个板块:articles和blog。
articles向所有人开放,提交的内容经老A审核后merge进入主线;
blog的内容则由老A定期从articles中筛选,进入blog的内容会以"水果刀叉"的名义在各技术博客平台上发布。
#articles提交细则
- 内容要求:articles中提交的内容必须为原创。
- 内容建议:每位contributor在一定时间窗口内聚焦到一个技术话题上,将它打穿打透后再逐步扩展。重点要探究"为什么",而不只是"怎么做"。因为我们的宗旨是为彼此消解积累知识、掌握技术的时间成本,如果只是搬运"*度一下"就能找到的信息,显然不符合这一宗旨。
- 格式要求:
- 新提交的文档,在SGDevX/articles下创建子目录,以
yyyymmdd+主题命名(如20160716BinderLearning),将文档放在此目录下。一个主题下的多篇文档可以都放入此目录。 - 文档必须为markdown格式,每个主题目录下的主文档必须命名为README.md。
- 如果文档中有引用图片,必须在文档同目录下创建一个和文档同名的文件夹,把图片放在里面。比如在
20160716BinderLearning/README.md中引用了图片img.png,必须将图片放在20160716BinderLearning/README/img.png。这样做的目的是为在本地编辑markdown文档的时候可以预览图片,同时用hexo生成的静态网页也能找到图片。 - 提交一篇新主题的文档,向中央仓库发起pull request时,在comments中附上"主题:xxxx",以便committer在SGDevX/articles/README.md中为之添加索引。
- 新提交的文档,在SGDevX/articles下创建子目录,以
💡contributor向articles贡献内容的操作步骤如下:
- 将中央仓库Fork到个人仓库。注册GitHub账号,进入SGDevX/articles,点击右上角
Fork按钮将articles的中央仓库拷贝到自己的个人仓库。 - 从个人仓库Clone到本地。
- 如果是首次操作,直接Clone即可。Windows下可以使用Git for Windows+TortoiseGit,macOS下,我习惯使用SourceTree。
- 如果本地已经存在Clone的副本,则需要现将该副本与中央仓库保持一致(注意:不是个人仓库),具体做法是在项目的remote地址中添加中央仓库,取名为upstream,从upstream拉取内容到本地的Clone副本,成功后再把本地内容推送到自己的个人仓库。
- 在本地副本中完成编辑,并及时提交到自己的个人仓库。
- 将完成的作品推送到中央仓库。在自己的个人仓库中点击"New pull request",选择"base fork"为SGDevX/articles,"base"为master,点击"Create pull request"发起推送。建议在comments中提供尽可能详细的信息,比如主题内容,更新计划或者你计划打穿什么技术模块等等,以便committer在合并入主线的时候更好地维护,也有助于committer了解你的目标,吸纳你入伙。
💡每个committer在收到Pull requests后,都可以负责将该请求合入主线,在合入的时候需要注意:
- 必须要通读提交的内容。这不只是要求,也是你愿意加入A组的目的——扩展自己的知识边界。
- 对于不符合规范的提交,可以驳回,需要在comments中说明原因,以便给contributor作为修改参考。
- committer会定期讨论,向提交积极,话题有深度的contributor发出邀请,邀请被接受后即成为SGDevX的committer,即A组成员。老A们会组织不定期讨论、分享以及线上线下活动。
- 半年内没有有效提交的A组成员视为自动退出,这是退出组织的唯一条件。
blog板块只有A组成员才能操作,他们会至少每周讨论一次,确定可以进入blog的内容。大家会以打造产品的心态来维护blog,从内容选材,到语言文字,到排版配图等等。blog板块在github上以博客的形式首发,并在其它各大技术博客平台同步更新。
📍站内事务的讨论请移步Issues区。在那里可以发起规则的制定、修改议题,可以针对已发布的技术议题展开讨论,SGDevX还会在那里发布议题征集帖,相关的提交会被优先考虑吸纳入伙。
🔔我们在articles板块保持尽可能地开放,欢迎所有人参与贡献,也欢迎所有人从中吸取养分,欢迎在Iusses中有充分的碰撞。但是SGDevX对于吸纳新成员偏向谨慎,因为要确保老A成员的技术成色,确保老A组合起来能啃下更大的骨头。对于收到邀请的同学也请谨慎评估,因为通往巅峰从来都没有现成的路,需要耐力、需要实力、更需要对技术的无限热爱。也许走在先遣队后面也是不错的选择😜。