Leahnaya/Magic-Spoiler
1
0
Fork 0
mirror of https://github.com/Cockatrice/Magic-Spoiler.git synced 2026-03-21 17:54:59 -05:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
d83827b4de
Magic-Spoiler/.github/CONTRIBUTING.md
tooomm d83827b4de
Update CONTRIBUTING.md (#212)
2018-05-24 20:16:28 +02:00

2.1 KiB
Raw Blame History

Contributing to Magic-Spoiler

Thank you for your interest in contributing to Magic-Spoiler! This project is an attempt to create a central source for new Magic: the Gathering spoilers and provide data files for miscellaneous projects like Cockatrice.

How can I help?

Magic-Spoiler grabs its data from many sources, but those sources often contain errors. If you just want to improve the card data and fix errors, you can start in the errors.yml file in the files branch or our issue tracker. Once you've found an error, whether it be in the errors.json file or from using the data files, make sure that error hasn't already been fixed in the appropriate file on the files branch. If it's still present, let's get it fixed!

  • If the error is with one of the fields in a card, check our cards_corrections.yml file.
  • If the card shouldn't exist at all, check the cards_delete.yml file.
    This file is just an array of cards to delete. card name is case sensitive!
  • If the card is a legitimate spoiler and it isn't showing up yet, you can manually add it. The file you want is cards_manual.yml. Make sure you link the spoiler source in your Pull Request (PR).

All PRs for card fixes should have the name of the card being fixed and the type of fix (fix/correction, delete, or manual). In the details of the PR, you MUST INCLUDE A VALID LINK to the page the spoiler is located at. For minor fixes, a link to the card image is OK. And of course link the issue you're fixing if there is one!

Anything else?

If you notice errors, please file an issue


Code improvement PRs are always welcome!