参与贡献
参与贡献
我们欢迎各种形式的贡献:文档修订、问题反馈、功能建议与代码提交。
反馈问题
在 GitHub Issues 中搜索是否已有相关讨论,再新建 Issue,并尽量附上:
- 复现步骤与预期结果
- 截图或错误日志
- 相关页面的链接
贡献文档
- Fork 本仓库并创建分支,例如
docs/update-getting-started - 在
content/下修改对应页面 - 本地运行
hugo server -D检查渲染效果 - 提交 Pull Request,并说明改动目的
中英文同步
站点默认语言为简体中文,英文内容使用 .en.md 后缀:
content/docs/getting-started.md # 简体中文(默认)
content/docs/getting-started.en.md # English修改内容时请尽量同步更新两种语言。若暂时无法翻译,可以在 Pull Request 中注明。
提交更改
- 提交信息使用清晰的英文描述,例如
docs: update getting started guide - 每个 Pull Request 聚焦一个主题,避免混杂无关改动
- 不要提交
public/等构建产物(已加入.gitignore) - 提交前运行一次完整构建:
hugo --gc --minify内容规范
- 使用 Markdown 编写内容,必要时使用 Hextra 短代码(如
cards、callout) - 页面标题简洁明确,通过
weight控制侧边栏顺序 - 引用外部资源时注明来源
- 尊重他人劳动成果,遵循仓库的开源许可证
不确定从哪里开始?可以先从修订错别字或补充示例入手,我们非常欢迎第一次贡献。
最后更新于