Skip to content

Latest commit

 

History

History
52 lines (38 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

52 lines (38 loc) · 1.64 KB

Contribution Guidelines

Hi, thank you for being interested in contributing to Hoyo Buddy, let's get started!
In case you have any questions, you can DM me on Discord or join the Discord server and tag me there.

Translation Contributions

Translations of Hoyo Buddy are hosted on Transifex, to contribute, DM me your e-mail and the language you want to translate so I can add you to the translation team.
If the language you want to translate is not listed below, DM me and I'll add it.

Languages Available

  • Chinese (China)
  • Chinese (Taiwan)
  • French
  • German
  • Indonesian
  • Japanese
  • Korean
  • Portuguese
  • Russian
  • Spanish
  • Thai
  • Vietamese

Code Contributions

Prerequisites

Before contributing, make sure you have basic understandings of the following:

  • Python
  • Asyncio
  • SQL
  • discord.py
  • Pillow (only if your contribution is about image generation)

Tools Needed

  • Any IDE, ones that support language server protocols are preferred
  • Git
  • Poetry

Setting Up

  1. Fork this repo and clone it to your environment using git clone
  2. Install the dependencies with poetry install --with dev --no-root
  3. Instal the pre-commits with pre-commit install
  4. (Optional) Install the ruff VSCode extension

And you should be good to go!
After making your changes, open a pull request and I will review your code.