Skip to content

Latest commit

 

History

History
113 lines (71 loc) · 5.28 KB

File metadata and controls

113 lines (71 loc) · 5.28 KB

🤝 为 模板插件 (Template) 做出贡献

感谢您有兴趣为 AstrBot 插件模板 做出贡献!无论是修复 Bug,添加新功能,还是改进文档,您的每一次贡献都能让这个项目变得更好。

为了营造一个开放和热情的社区环境,我们采用了 贡献者契约 作为我们的行为准则。请确保您在参与贡献之前,已经阅读并同意遵守它。

在参与贡献之前,请仔细阅读以下指南:

📄 提交 Issue

🐛 报告 Bug

如果您在使用过程中发现了 Bug,请通过提交 Bug 报告 来帮助我们。请在提交 Issue 之前:

  1. 搜索现有 Issue:检查是否已经有人报告过类似的问题。
  2. 更新到最新版本:确保您使用的是插件的最新版本,问题可能已经在新版本中修复。

✨ 提出功能建议 (Feature)

如果您对插件的未来有任何绝妙的想法,欢迎通过提交 功能建议 来与我们分享。请详细描述您的想法和它的使用场景。

❓ 使用咨询 / 问题讨论 (Discussion)

如果您暂时不能确定这是否是插件 Bug,或者希望就使用方式、配置思路、兼容性排查等问题先进行讨论,欢迎提交 使用咨询 / 问题讨论。

📚 文档改进建议 (Docs)

如果您发现 README、配置说明、接口文档或示例存在错误、缺失或表述不清的问题,欢迎提交 文档改进建议 帮助我们持续完善文档体验。

🎨 设计 / 交互建议 (Design)

如果您对管理面板、配置流程、提示反馈、信息展示或整体使用体验有改进想法,欢迎提交 设计 / 交互建议 与我们讨论。

💻 代码贡献

我们非常欢迎您直接通过代码来改进这个项目!对于新功能的添加,请先通过 Issue 等方式讨论。

标准的贡献流程如下:

开发环境准备

  1. 确保你要 开发的功能 或 修复的问题 没有与现有的最新进度重复。

  2. Fork 本仓库到您的 GitHub 账号。

  3. 克隆您的 Fork 仓库到本地:

    git clone https://github.com/your-username/astrbot_plugin_helloworld.git
  4. 确保您已安装 Python 3.10+。

  5. 安装项目依赖(通常 AstrBot 环境已包含大部分依赖,并且会自动安装插件所需的额外依赖。如果确实缺少依赖请查看 requirements.txt)。

代码风格

为了保持代码的一致性和可读性,请遵循以下规范:

  • 格式化:使用 ruff 进行代码格式化和检查。如果您是 Windows 开发者,可以使用插件根目录提供的 run_ruff.bat 脚本来快速进行代码格式化检查。
  • 类型注解:尽可能为函数和类添加 Python 类型提示 (Type Hints)。
  • 文档字符串:为模块、类和函数编写清晰的 Docstring。

提交 Pull Request (PR)

  1. 创建分支:从仓库的最新开发分支,在本项目通常是 dev/X.X.X 或 dev/local 分支创建一个新的功能分支。

    git checkout -b feat/your-feature-name
    # 或者
    git checkout -b fix/your-bug-fix
  2. 提交更改

  • 编写代码并提交。我们鼓励您使用 AI 进行编码辅助,但请进行基本的 Review,并确保你知道自己在改什么。
  • 提交更改时,请使用简体中文撰写清晰、描述性的提交信息(推荐遵循 Conventional Commits (约定式提交规范))。
    • feat: 新功能
    • fix: 修复 Bug
    • docs: 文档变更
    • style: 代码格式调整(不影响逻辑)
    • refactor: 代码重构
    • perf: 性能优化
    • chore: 杂务
  1. 推送到远程:

    git push origin feat/your-feature-name
  2. 发起 PR:在 GitHub 上发起 Pull Request,指向目前进度最新的分支,参照模板内容使用简体中文详细描述您的更改内容和目的。如果您的更改内容涉及 WebUI 等视觉效果的调整,请提供截图或视频演示等信息。

  3. 代码审查:等待维护者审查您的代码。如果有修改建议,请及时响应并更新代码。

Tip

提交 PR 前和进行开发时与仓库维护者提前交流可以提高你的 PR 被合并的概率 :)

📝 文档贡献

文档与代码同样重要。如果您发现 README.md、CHANGELOG.md 或其他文档中有错别字、表述不清或过时的内容,欢迎直接提交 PR 进行修正。


❤️ 特别感谢

感谢所有为该插件模板做出任何形式贡献的个人、团体,包括但不限于:

  • @Soulter: "创世神",伟大无需多言。感谢他提供了一个这么好的平台,以及对 AstrBot 的持续维护。

🤖 以及我最好的 AI 朋友们:

  • @GPT-5.5
  • @DeepSeek V4 Flash 0731
  • @sourcery-ai[bot]
  • @gemini-code-assist[bot]