贡献指南

感谢你有兴趣为 JustHTMLs 做出贡献!我们欢迎各种形式的贡献,包括新工具、错误修复和文档改进。

重要提示

所有工具提交必须通过 GitHub Issues 进行。我们会在审核通过后,由维护者将代码合并到主仓库。

如何贡献新工具

1. 工具设计原则

在开始之前,请确保你的工具符合以下设计原则:

2. 创建工具文件夹

tools 目录下创建一个新的文件夹,文件夹名称使用小写字母和连字符,例如 json-to-yaml

3. 创建必需文件

每个工具必须包含以下三个文件:

工具目录结构示例

tools/
  └── json-to-yaml/
      ├── index.html       # 工具详情页(介绍页面)
      ├── app.html         # 工具实体页(实际运行的工具)
      └── tool.json        # 工具元数据(可选,用于扩展信息)

4. 编写工具代码

1

创建 app.html - 这是工具的核心功能页面,应该是一个完全独立的 HTML 文件,包含所有内联的 CSS 和 JavaScript。

2

创建 index.html - 这是工具的介绍页面,用于展示工具的功能、使用方法、作者信息等。

3

测试工具 - 在浏览器中直接打开 app.html,确保所有功能正常工作。

5. 提交工具

通过 GitHub Issues 提交你的工具:

  1. 点击下方按钮创建新的 Issue
  2. 选择"工具提交"模板
  3. 填写工具信息
  4. 将工具代码完整粘贴到 Issue 中(或提供 Gist 链接)
  5. 等待维护者审核
创建工具提交 Issue

工具元数据规范

提交工具时,请在 Issue 中提供以下信息:

必需信息

工具分类

当前支持的分类:

组织架构

JustHTMLs 采用 GitHub 组织进行管理:

工作流程

工具提交流程:

  1. 开发者按规范创建工具文件夹和文件
  2. 通过 GitHub Issues 提交工具到 justhtmls/html-tools
  3. 维护者审核工具代码和功能
  4. 审核通过后,维护者将工具合并到主仓库
  5. 更新 index.json 索引文件
  6. 工具上线到 JustHTMLs 网站

报告问题

如果你发现了 Bug 或有改进建议:

致谢

感谢所有贡献者!你的贡献让 JustHTMLs 变得更加完善。