Skip to content

贡献代码

感谢你对 Ameath 的兴趣!我们欢迎各种形式的贡献。

🤝 贡献方式

🐛 报告问题

如果你发现了 Bug,或者有功能建议,请在 Gitee Issues 中提交。

提交 Issue 时,请尽量包含:

  • 你的操作系统和版本
  • 问题描述和复现步骤
  • 相关的截图或日志

🔧 提交代码

  1. Fork 仓库

    点击 Gitee 仓库页面的 Fork 按钮,将仓库 fork 到你的账号下。

  2. 克隆你的 Fork

    bash
    git clone https://gitee.com/你的用户名/ameath.git
    cd amearth
  3. 创建分支

    bash
    git checkout -b feature/你的功能名
    # 或者修复 bug
    git checkout -b fix/问题描述
  4. 进行修改

    确保你的代码:

    • 遵循项目现有的代码风格
    • 不引入新的依赖(除非必要)
    • 经过测试验证
  5. 提交并推送

    bash
    git add .
    git commit -m "feat: 添加了 XXX 功能"
    git push origin feature/你的功能名
  6. 创建 Pull Request

    在 Gitee 上创建 Pull Request,描述你的改动内容和动机。

📋 Issue 认领

如果你想实现某个 Issue 中的需求,请在 Issue 下留言告知我,避免重复工作。

🛠️ 开发环境

依赖

  • Python 3.9+
  • Pillow
  • pystray

本地运行

bash
# 克隆仓库
git clone https://gitee.com/lzy-buaa-jdi/ameath.git

# 安装依赖
pip install -r requirements.txt

# 运行
python main.py

代码规范

  • 使用 Python standard style(PEP 8)
  • 变量命名清晰,避免无意义的缩写
  • 函数和类添加 docstring 说明

📜 特别感谢

  • 感谢 B站 up @_BLZ_ 提供的 gif 素材

但愿我会让你感到骄傲,但愿我没有让你失望 — Ameath

基于 MIT 协议开源