wbrawner/ffc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ffc/CONTRIBUTING.md
Rene Fischer 28e2e57581
add info about deck types
2021-06-13 12:16:56 +02:00

4 KiB
Raw Permalink Blame History

Contributing to Fancy Flashcard

I want to create decks and make them available so that everyone can learn and benefit from it

A convenient way to create decks is still in progress but we offer a CLI if you are experienced with the command line. After creating a deck you have several options, most of them requiring some technical expertise currently. You can share it with your friends via messenger, email, ... and use "Import JSON File" to import your deck saved as a local file.

You can also upload it to a webserver and import the deck via URL. Then you can share this URL with everyone you want to have acces to and they can import it easily without exchanging files manually. But keep in mind that such decks are publicly available and can be used by anyone. At least you can obscure the URL and configure your webserver to accordingly so that it's hard to find for people that shouldn't know of it.

Additionally, if you actually want to share your decks with all Fancy Flashcard users, we offer the possibility to add it as a Third Party Deck. Therefore it needs to be accessible on the web via URL. Just edit third-party-decks.json and open a pull request. When adding a new deck you can choose between three types to add or add none at all. The three types are official for decks created by us, curated for staff picked decks and ones created by our fellow colleagues and sponsored if you want to pay to add a deck. If none of these types are selected it is simply a 'featured' deck, as described in the docs.

If you need help with any of the steps, feel free to contact us (via issues or email).

I'm a developer and want to implement features and fix bugs

You may want to checkout our documentation and ideas first. As we do not cover all technical details there, feel free to contact us (@FischerRene, @nikolockenvitz) if something is not clear. For bug fixes and minor features you can open a pull request. Before implementing major features we suggest to discuss it with us (via issues or email).

I have feedback, have an idea, found a bug, ...

We highly appreciate your feedback as it helps to improve Fancy Flashcard. Currently the easiest way would be to open an issue. Of course you could also contact us (@FischerRene, @nikolockenvitz) via email.

If you have an idea or found a bug we suggest the same, just open an issue. Before doing that you can check whether a similar one has been opened before. Because Fancy Flashcard is relatively small at the moment, it wouldn't matter if you don't check and possibly open a duplicate issue. But as we hope to grow over time, avoiding duplicates would help us to focus on improving Fancy Flashcard.

I want to translate Fancy Flashcard

Internationalization is in our backlog but we didn't started with it yet. We have the ability to add German but for other languages we need your help. Just open a pull request or ask us for more information to add a new language.