From 6ea2e4e963671cf274a68ca744f9b75a19d08a14 Mon Sep 17 00:00:00 2001 From: Teddi <83455454+teddinotteddy@users.noreply.github.com> Date: Sat, 19 Mar 2022 09:27:59 -0500 Subject: [PATCH] Added Quotes Documentation (#2722) --- CONTRIBUTING.md | 2 ++ QUOTES.md | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+) create mode 100644 QUOTES.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 51ca10671..915609148 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -145,6 +145,8 @@ Before submitting a theme make sure... - Verify the `id` property is incremented correctly - Please do not add extremely short quotes (less than 60 characters) +(If you want to contribute quotes but don't know how, check [QUOTES.md](https://github.com/teddinotteddy/monkeytype/blob/8d5ffde578030a07458cec391e862f8f3cd5b4b4/QUOTES.md)) + ## Questions If you have any questions, comments, concerns, or problems let me know on [GitHub](https://github.com/Miodec), [Discord](https://discord.gg/monkeytype) in the `#development` channel, or ask a question on Monkeytype's [GitHub discussions](https://github.com/Miodec/monkeytype/discussions) and a contributor will be happy to assist you. diff --git a/QUOTES.md b/QUOTES.md new file mode 100644 index 000000000..6732f4ecc --- /dev/null +++ b/QUOTES.md @@ -0,0 +1,40 @@ +### **Table of Contents** + +- [Forking Monkeytype](#forking-monkeytype) +- [Creating Quotes](#creating-quotes) +- [Committing Quotes](#committing-quotes) +- [Quote Guidelines](#quote-guidelines) + +### Forking Monkeytype + +First you will have to copy the Monkeytype repository also known as forking. Go to the [Monkeytype Repo](https://github.com/Miodec/monkeytype/) and then click the "fork" button. + +Screen Shot 2022-01-12 at 11 51 49 AM + +## Creating Quotes + +After you forked the Monkeytype repository you can now add your quotes. (If you haven't already forked the repository, refer to this [section](#forking-monkeytype).) (Before continuing to the next step make sure the quote's language exists in Monkeytype) Add this code in at the end of the quotes `./frontend/static/quotes/[language].json`: +``` +{ + "text": "[quote]", + "source": "[source]", + "id": [number of the quote] + "length": [number of characters in quote] +} +``` +(If the language does exist in Monkeytype, but there are no quotes for it create a new file for the language) + +### Committing Quotes + +Once you have added your quotes(s), you now need to create a pull request to the main Monkeytype repository. Go to the branch where you created your languages on GitHub. Then make sure your branch is up to date. Once it is up to date, click "contribute". + +Update branch: +Screenshot showing how to update the fork to match the main Monkeytype repository + +Create a pull request: +Screenshot showing how to create a pull request to the main Monkeytype repository + +## Quote Guidelines + +Make sure your quote(s) follows the quote guidelines. +[Quote guidelines](https://github.com/Miodec/monkeytype/blob/master/CONTRIBUTING.md#quote-guidelines)