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

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
tooomm 2019-04-04 11:14:08 +02:00 committed by GitHub
parent 297408ca83
commit a497d7e81a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
.github/CONTRIBUTING.md vendored
View File

@ -1,19 +1,23 @@
# Contributing to Magic-Spoiler #
Thank you for your interest in contributing to Magic-Spoiler!
Thank you for your interest in contributing to Magic-Spoiler!<br>
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](https://github.com/Cockatrice/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](https://github.com/Cockatrice/Magic-Spoiler/blob/files/errors.yml) file in the [files branch](https://github.com/Cockatrice/Magic-Spoiler/tree/files) or our [issue tracker](https://github.com/Cockatrice/Magic-Spoiler/issues).
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](https://github.com/Cockatrice/Magic-Spoiler/tree/files). 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](https://github.com/Cockatrice/Magic-Spoiler/blob/master/cards_corrections.yml) file.
- If the card shouldn't exist at all, check the [cards_delete.yml](https://github.com/Cockatrice/Magic-Spoiler/blob/master/cards_delete.yml) file.<br>
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](https://github.com/Cockatrice/Magic-Spoiler/blob/master/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!
## How can I help? ##
Magic-Spoiler grabs its data from [Scryfall](https://scryfall.com/), but there can be errors of course.
If you want to improve the card data and fix errors for all users, you simply have to report them directly to Scryfall.
Once you've found a mistake in our data files, make sure that error hasn't already been fixed at the Scryfall webpage in betweeen. If it's still present there, let's get it fixed!
- If the error is with one of the fields in a card (e.g. a spelling error or missing cmc) search for that card on the Scryfall webpage. Below the card art on the left, there are some links. Choose the botton one (`Report card issue`) and provide the information in the form. Once their team check & fixes the errors, it'll show up in our spoiler files, too.<br>
It only takes a few days - be patient.
- If the card is a legitimate spoiler and it isn't showing up yet, you can request it by [contacting the Scryfall support](https://scryfall.com/contact) and let them know. Make sure to link the official spoiler source in your report.
- If the card shouldn't exist at all, let the Scryfall team know as well, please.
What you should **NOT** do however, is to submit PR's to our files branch and fix the xml/json files there directly.<br>
You have to provide updates to Scryfall as all other changes would get overridden again.
## Anything else? ##
If you notice errors, please file an [issue](https://github.com/Cockatrice/Magic-Spoiler/issues)
If you notice any other errors or have suggestions to the code, please [file an issue](https://github.com/Cockatrice/Magic-Spoiler/issues) in our repository.
<br>