1
0
mirror of https://github.com/tcgdex/cards-database.git synced 2025-04-22 10:52:10 +00:00
cards-database/CONTRIBUTING.md

1.7 KiB

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, a Discussion or a Pull Request

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 if it's already well though, or create a new discussion to speak about it

Pushing changes

To send changes to our repository, you will have to follow the next steps:

  • Fork 🍴 the project. see the fork button 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 by selecting your repository patch with our master branch
  • we don't like , so if your pull request has its automated checks ending with the red cross, please double check your changes until it show the awesome 🟢, or ask for help !
  • If you pull request is ready for review you can go to the 🏖️ and we will handle the rest !

coding Convention

Install the plugin .editorconfig in your dev environment if it's not already done and thats it !

for those who don't want to install it the basic are these:

  • Indent using tab
  • don't uglify your code (why would you even do it)