Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (19 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

30 lines (19 loc) · 1.7 KB
Raw

Contributing / 贡献指南

Thank you for improving this beginner-first guide. 感谢你帮助改进这份初学者指南。

Before opening a change / 提交前

  • Keep Chinese and English guides corresponding. Commands and factual behavior must match in both languages.
  • 中文和英文指南应保持对应，命令和功能描述必须一致。
  • Test claims against the current CLI. Do not document planned behavior as shipped behavior.
  • Verify theme files locally and include the public source URL, upstream project, retrieval date, format, and license terms.
  • Do not submit bulk theme catalogs. A focused format fix or clearly sourced example is easier to review.
  • Never include tokens, private hostnames, personal paths, or unredacted configuration.

Development / 开发

Use macOS with the system Bash. Run:

bash tests/run.sh

For code changes, add a focused regression test. For paired documentation, keep heading structure aligned and make commands identical. Explain user-visible behavior and rollback impact in the pull request.

代码修改应包含聚焦的回归测试；双语文档应保持标题结构和命令一致。请在 PR 中说明用户可见变化及回退影响。

Theme provenance / 主题来源

A theme contribution must identify its original source and applicable license. Repository MIT terms cover only original project code and documentation; they do not relicense third-party theme data. By contributing original material, you agree to license it under MIT.

主题贡献必须注明原始来源和适用许可证。本仓库 MIT 条款仅覆盖项目原创代码与文档，不会重新许可第三方主题数据。提交原创内容即表示同意按 MIT 许可。