Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
seriaati committed Mar 10, 2024
2 parents 7019d93 + 3964d07 commit bf552d4
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# 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](https://discord.com/users/410036441129943050) or join the [Discord server](https://dsc.gg/hoyo-buddy) and tag me there.

# Translation Contributions
Translations of Hoyo Buddy are hosted on [Transifex](https://app.transifex.com/hoyo-buddy/hoyo-buddy/dashboard/), 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](https://github.com/Rapptz/discord.py)
- [Pillow](https://github.com/python-pillow/Pillow) (only if your contribution is about image generation)

## Tools Needed
- Any IDE, ones that support language server protocols are preferred
- Git
- [Poetry](https://python-poetry.org/)

## 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](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff)

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

0 comments on commit bf552d4

Please sign in to comment.