Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

57 lines (39 loc) · 1.95 KB

我该如何参与开发?

配置环境

首先你需要安装 uv
然后:

# 配置基础 Python 环境
uv python install 3.10

# 克隆仓库
git clone https://github.com/A-Minos/nonebot-plugin-tetris-stats.git
cd nonebot-plugin-tetris-stats

# 安装依赖
uv sync

开发

代码开发

  1. 代码静态检查使用 ruff,你可以为你的ide安装对应插件来使用,也可以在命令行使用ruff check ./nonebot_plugin_tetris_stats/来检查代码。
  2. 代码格式化使用 ruff,你可以为你的ide安装对应插件来使用,也可以在命令行使用ruff format ./nonebot_plugin_tetris_stats/来格式化代码。
  3. 类型检查同时使用 basedpyrightmypy,你可以为你的ide安装对应插件来使用。 也可以在命令行使用下面的命令来检查代码:
# basedpyright
basedpyright ./nonebot_plugin_tetris_stats/

# mypy
mypy ./nonebot_plugin_tetris_stats/

国际化

本项目使用 Tarina 提供国际化支持。

添加新的语言

  1. 进入 ./nonebot_plugin_tetris_stats/i18n/ 目录。
  2. 运行 tarina-lang create {语言代码} * 请注意,语言代码最好符合 IETF语言标签 的规范。
  3. 编辑生成的 ./nonebot_plugin_tetris_stats/i18n/{语言代码}.json 文件。

更新已有语言

  1. 进入 ./nonebot_plugin_tetris_stats/i18n/ 目录。
  2. 编辑对应的 ./nonebot_plugin_tetris_stats/i18n/{语言代码}.json 文件。

添加新的条目

  1. 进入 ./nonebot_plugin_tetris_stats/i18n/ 目录。
  2. 编辑 .template.json 文件。
  3. 运行 tarina-lang schema && tarina-lang model
  4. 修改语言文件,至少为en-US.json添加新的条目。