贡献指南

感谢您对本项目的兴趣！为了确保项目的高质量和一致性，请遵循以下指南进行贡献。

先决条件

• Python 3.9+
• git
• uv
• pre-commit

开发流程

配置开发环境

# 安装 uv 和 pre-commit
# https://docs.astral.sh/uv/
# https://pre-commit.com/#install

# 在 GitHub 上分叉存储库并在本地克隆您的分叉。
git clone git@github.com:<your username>/QQMusicApi.git
cd QQMusicApi

# 安装开发依赖
python install-dev.py

构建文档

如果您对文档进行了任何更改（包括对将出现在 API 文档中的函数签名、类定义或文档字符串的更改），请确保其构建成功。

# 构建文档
uv run mkdocs build

在线文档

uv run mkdocs serve

创建 Pull Request

Note

请向 main 分支发起 Pull Request

提交更改，将分支推送到 GitHub，然后创建拉取请求。

请遵循拉取请求模板并填写尽可能多的信息。链接到任何相关问题并包含您的更改的说明。

代码规范

• 代码风格遵循 Google Python Style
• 代码格式遵循 PEP8

代码注释

• 注释内容包括：模块注释、类注释、函数注释、参数类型注释、返回值注释
• 注释风格遵循 Google-style docstrings

文档规范

文档使用 Material for MkDocs 构建

API 文档使用 mkdocstrings 构建

Markdown 拓展语法

• PyMdown Extensions(Material for MkDocs)

提交规范

本项目采用 Conventional Commits 规范