跳到主要内容

修订与贡献

公约由所有人共同编辑。没有 GitHub 账号,也可以通过邮件或自己的博客参与;你不需要懂开发,只需一条清楚的建议,就能让公约变得更好。


参与方式

任选其中一种方式参与:

1️⃣ 发送邮件

适合没有 GitHub 账号,或希望直接沟通的朋友。

把建议发送至 hi@zhblog.org,写明想修改的内容、你的建议和修改理由。像平常写信一样表达就好,不必拘泥格式。建议被采纳后,默认会在修订记录中署名;如希望匿名,请在邮件中说明。

2️⃣ 在自己的博客写下讨论

适合希望深入表达观点,并把思考和讨论留在自己博客上的朋友。写博文本身就是最“独立博客”的参与方式:

  1. 在你的博客上发表对公约的讨论文章;
  2. 通过邮件或议题告知我们文章链接;
  3. 有价值的观点将被纳入社区讨论,据此产生的修订会在修订记录中标注来源。

3️⃣ 提交议题或参与讨论

适合拥有 GitHub 账号、希望公开讨论交流的朋友,无需任何 Git 知识。

在 GitHub 上发起新的讨论或议题,说明希望修改什么、建议怎么表述,以及修改的原因。开放式想法可以优先放在讨论区,后续进展会留在公开页面。

若确定有 Bug 或字词错误等具体问题,建议提交议题;否则请发起讨论。

前往 GitHub 讨论区
前往 GitHub 议题页

4️⃣ 网页直接编辑文字

适合有 GitHub 账号、想亲手修改文字但不熟悉 Git 的朋友,全程在浏览器中完成。

  1. 打开公约正文的源文件编辑页,登录 GitHub;
  2. 像编辑普通文档一样修改文字;
  3. 确认无误,点击绿色提交按钮(Commit changes);
  4. GitHub 会自动生成一份合并请求(Pull Request),等待维护者审阅。

打开正文编辑页

5️⃣ Git 工作流

适合熟悉 Git,或希望贡献网站代码与设计的朋友。

  1. 复制(Fork)项目仓库并创建新分支;
  2. 公约正文位于 src/content/guidelines.md,其余页面也在 src/content/ 目录中;
  3. 本地预览:npm install && npm run dev;
  4. 提交合并请求,并简要说明修订意图。

查看项目仓库


其他贡献

除修订条文外,你还可以:

修订流程

  1. 提案:通过邮件、博客文章、讨论、议题或代码提交提出建议;
  2. 讨论:涉及实质性变化时,邀请社区公开讨论,尽量形成共识;
  3. 修订:将达成共识的内容合并进正文;
  4. 发布:更新网站,并在修订记录中登记变更。

哪些改动需要公示

错别字、标点和排版等不改变条款含义的调整,可以直接并入正文,并在修订记录登记。

若条款语义发生变化,或新增、删除条款,则应先在 GitHub 讨论区公示,充分听取社区意见后再决定是否合并。

修订原则