nonebot-plugin-tetris-stats/CONTRIBUTING.en-US.md

How to Contribute?

Setting Up the Environment

For Developers with Basic Python Knowledge

First, you need Python 3.10 and Poetry.
Then, you need to clone this repository to your local machine using the git clone command, and install dependencies using poetry install --sync.

For Developers with Limited Python Knowledge

Here are my recommended best practices:

# Install uv
# Please refer to https://docs.astral.sh/uv/getting-started/installation/

# Set up the basic Python environment
uv python install 3.10
uv tool install poetry

# Clone the repository
git clone https://github.com/A-Minos/nonebot-plugin-tetris-stats.git
cd nonebot-plugin-tetris-stats

# Install dependencies
uv run --no-project --python 3.10 poetry env use python
poetry install --sync

Development

Code Development

1. For static code analysis, use ruff. You can install the corresponding plugin for your IDE or use the command line with ruff check ./nonebot_plugin_tetris_stats/ to check the code.
2. For code formatting, use ruff. You can install the corresponding plugin for your IDE or use the command line with ruff format ./nonebot_plugin_tetris_stats/ to format the code.
3. For type checking, use both basedpyright and mypy. You can install the corresponding plugins for your IDE or use the following commands in the terminal to check the code:

# basedpyright
basedpyright ./nonebot_plugin_tetris_stats/

# mypy
mypy ./nonebot_plugin_tetris_stats/

Internationalization

This project uses Tarina for internationalization support.

Adding a New Language

1. Navigate to the ./nonebot_plugin_tetris_stats/i18n/ directory.
2. Run tarina-lang create {language_code} * Please note that the language code should preferably follow the IETF language tag standard.
3. Edit the generated ./nonebot_plugin_tetris_stats/i18n/{language_code}.json file.

Updating an Existing Language

1. Navigate to the ./nonebot_plugin_tetris_stats/i18n/ directory.
2. Edit the corresponding ./nonebot_plugin_tetris_stats/i18n/{language_code}.json file.

Adding New Entries

1. Navigate to the ./nonebot_plugin_tetris_stats/i18n/ directory.
2. Edit the .template.json file.
3. Run tarina-lang schema && tarina-lang model.
4. Modify the language files, adding new entries at least to en-US.json.