mirror of
https://github.com/tcgdex/cards-database.git
synced 2025-04-22 19:02:10 +00:00
33 lines
1.5 KiB
Markdown
33 lines
1.5 KiB
Markdown
# How to contribute
|
|
|
|
If you are here, I like you already !
|
|
|
|
## TL::DR
|
|
|
|
A card is missing or has incorrect informations?
|
|
|
|
feel free to contribute to the database by adding [an Issue](https://github.com/tcgdex/cards-database/issues/new), [a Discussion](https://github.com/tcgdex/cards-database/discussions/new) or [a Pull Request](https://github.com/tcgdex/cards-database/pulls/compare)
|
|
|
|
## Database Issue or recomendation
|
|
|
|
We would love you to see what you can propose to make the Database/API better !
|
|
|
|
to do this you can check if there is not already an issue/discussion about it, and if there is nothing, add a new [Issues](https://github.com/tcgdex/cards-database/issues/new) if it's already well though, or [create a new discussion](https://github.com/tcgdex/cards-database/discussions/new) to speak about it
|
|
|
|
## Pushing changes
|
|
|
|
To send changes to our repository, you will have to follow the next steps:
|
|
|
|
- Fork 🍴 the project. _see at the top right of the screen_
|
|
- make the changes you want in your Repository.
|
|
- Create a Pull request here https://github.com/tcgdex/cards-database/compare
|
|
- we don't like ❌, so if your pull request has its automated checks ending with the red cross, please double check your change until it show the awesome 🟢, or ask for help !
|
|
- If you pull request is ready for review you can go the 🏖️ and we will handle the rest !
|
|
|
|
## coding Convention
|
|
|
|
Install in your dev environment the plugin `.editorconfig` is not already done and thats it !
|
|
|
|
- Indent using `tab`
|
|
- don't uglify your code (_why would you even do it_)
|