搜索文章 Ctrl K
返回
0

为 Wavelog 做贡献

为 Wavelog 做贡献（Contributing to Wavelog）

目录

感谢你考虑为 Wavelog 做贡献。这个项目由业余无线电爱好者为业余无线电爱好者开发，每一份贡献——无论是缺陷报告、PR 还是文档改进——都很有价值。

贡献方式

报告缺陷

如果你在 Wavelog 中发现了缺陷，请在 GitHub 上提交 issue：

提交新 issue 之前，请先搜索已有 issue，避免重复。请尽可能详细地说明：Wavelog 版本、PHP 版本、浏览器以及复现步骤。

提出功能建议

欢迎提出功能需求。请在 GitHub 上发起讨论并说明使用场景。需求越具体、越聚焦，评估起来就越容易。

改进文档

文档位于单独的仓库中，对首次贡献者来说始终是一个很好的切入点。修正拼写错误、把操作说明写清楚，或补充缺失的示例。参见下文的本地文档预览。

提交 PR

  1. 在 GitHub 上 fork 仓库。
  2. 从 dev 创建功能分支：

bash git checkout -b describe-your-change

  1. 修改代码，并用有描述性的提交信息提交。
  2. 推送你的分支，并针对 dev 发起 PR。
  3. 在 PR 描述中说明你改了什么、为什么改。

维护者会审阅你的 PR。请耐心等待——所有贡献者都是在业余时间参与 Wavelog 的。

代码准则

  • Wavelog 构建在 CodeIgniter 3、Bootstrap 和 jQuery 之上。
  • 遵循现有代码风格——一致性比个人偏好更重要。
  • 保持改动聚焦。每项逻辑改动对应一个 PR。
  • 不要包含无关的格式或空白改动。
  • 提交前在本地测试你的改动。
  • 在添加新的（子）函数之前深入阅读代码，避免重复实现。非常欢迎复用。
  • 添加代码时请记住：它必须安全、可扩展，既能跑在资源极少的机器上，也能跑在大型环境中
  • 非常欢迎外部工具，但在为你的工具添加新的 API 端点之前，请先讨论/申请。这样双方都能省力
  • 如果在开发中使用 AI/CodePilot 助手，请确保你能理解你和你的 AI 贡献了什么。请准备好回答提问。
  • 这是一个由人类创建的项目。我们希望一直如此。不允许由 AI 生成的提交。如有可能，请确保你的提交已签名/已验证。
  • 纯 AI 生成的 PR 将被拒绝。

前端约定见风格指南。

文档准则

  • 用清晰、平实的英文写作。尽可能避免行话。
  • 重要提示请使用警示块（!!! note、!!! tip、!!! warning）。示例见 Zensical 文档
  • 欢迎提供截图，但必须保持更新——在可行的情况下优先使用文字说明。
  • 引用外部资源时，请使用带 target="_blank" rel="noopener noreferrer" 的锚点标签，并避免用 <a> 标签表示相对链接。相对链接请改用 Markdown 语法。 示例：

```html

Local Documentation Preview

External Link ```

本地文档预览

本地开发 Wavelog 文档需要：

  • docker
  • make

文档使用 Zensical。要在本地预览改动：

make serve

在为文档创建 PR 之前，请在本地运行测试！

make test

文档将可通过 http://localhost:8000 访问。

翻译

如何参与翻译，见翻译指南。

有问题？

请发起 GitHub 讨论。

73 de Wavelog 团队

Wavelog 手册（中文版） / 为 Wavelog 做贡献 0 字 0 行 bg8lng
2026-10-21T12:42:35.035705039Z 2026-10-21T12:42:53.742424009Z