monkeytypegame/monkeytype
1
1
Fork 0
mirror of https://github.com/monkeytypegame/monkeytype.git synced 2024-09-20 07:16:17 +08:00
Code Issues Packages Projects Releases Wiki Activity
monkeytype/QUOTES.md

43 lines
2.1 KiB
Markdown
Raw Normal View History

Added Quotes Documentation (#2722)
2022-03-19 22:27:59 +08:00
### **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.
<img width="1552" alt="Screen Shot 2022-01-12 at 11 51 49 AM" src="https://user-images.githubusercontent.com/83455454/149194972-23343642-7a1f-4c0c-b5f2-36f4b39a2639.png">
## 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`:
v1.14.1 (#2745) * updated default config to fix incorrect font button being highlighted * Convert account controller to ts (#2731) * using modular sdk * removing last script * replacing more code * unused code * removed unused code * removed unused code * importing auth * using analytics controller * importing auth and analytics * importing auth * updated git ignore * fixed path * removed live config from gitignore * added error message when failing to initialize firebase * added live config using live config when building production * removed unused code * fixed incorrect function use * added example config * added a step to the contributing guide * optional steps * fixed path * using example in source code so that github actions dont cry like little babies * using function correctly * using function correctly * ignoring live * removed * added action webpack config * bruce said "no-no" This reverts commit 0a1e5e1660200fe30378d36cb6778772e2f79cc8. * Fix * Add ignore * updated instructions * using correct functions * using correct function * missing parameter * using correct function * using correct function * removed ts ignores * using new functions * removed refresh * using new functions * merge fix * fixed merge * regenereated lockfile * using correct function * defaulting to the email thats already entered * storing default snap in a file * optional parameter * made parameters non optional * converted file to ts * removed unused parameters * removed unnecessary optional chaining * destructuring array * added a function to create error message * removed type * removed duplicate gitignore * removed no check Co-authored-by: Bruception <bberr022@fiu.edu> * Include dev branch in CI (#2739) * Decreased filesize and introduced chunk splitting (#2732) Rizwanmustafa * Decreased filesize * Introduce splitting for vendors * Added HTML webpack plugin for dynamic change of chunkhash and minification on production * Added bundle analyzer plugin for webpack * Prevent analyzer from opening on its own * updated contributors list * Package lock update * Created separate webpack config for analysing bundle * Standardize paths in webpack base config * Added devtool in dev webpack config * Minor issues * Based audit config off of the production config, saved exact packages and renamed some constants * Saved exact version of packages * Rename Config * Added intellisense for webpack configs * Added script for using audit config * Simple changes * Removed unnecessary cd and replaced webpack with npx wepback * added npm script accessible from root dir since audit is now a separate script, reenabled auto opening Co-authored-by: Miodec <bartnikjack@gmail.com> * Enable live reloading (#2738) bruception * Enable live reloading * Update scripts and documentation * Fix resolve * Use resolve * Fix layoutfluid timer warnings (#2740) Ferotiq * reduced date-fns import size * using inline source map so that code is debuggable * removed tinycolor2 dependency * Migrate Chart.js to 3.7.1 (#2735) DanGonite57 * Migrate Chart.js to 3.7.1 * Show funbox label with StartGraphsAtZero disabled * Fix label positioners * Include dev branch in CI (#2739) * Remove draw animation * Avoid RangeError with no data * Disable account chart initial render animation * Add temporary type assertion for options.animation * Test disabling animations via updateColors * Test re-update chart after resetting animation duration * Test dataset specific animation duration * Disable animations for now * Remove unused annotation Co-authored-by: Bruce Berrios <58147810+Bruception@users.noreply.github.com> * installed dev dependency to stop audit from complaining * removed mr mime dev dependency regenerate package-lock * not updating live burst when its disabled * using vanilla js to increase performance * updating chart once instead of 3 times * made log async * increased minimum wordset length to disable repeating words to 4 this stops infinite A B C sequences closes #2742 * increased tick padding * added some padding to stop data points from being cut off * fixed account graphs not being responsive * removed unnecessary style * updated button active color * Server version (#2746) Bruception * Add server version * typo * Fix logic * Moved to utility * Actually save version * Move logic order * updated metric name * removed unnecessary else Co-authored-by: Bruception <bberr022@fiu.edu> Co-authored-by: Bruce Berrios <58147810+Bruception@users.noreply.github.com> Co-authored-by: Rizwan Mustafa <rizwanmustafa0000@gmail.com> Co-authored-by: Evan <64989416+Ferotiq@users.noreply.github.com> Co-authored-by: DanGonite57 <danzinc57@gmail.com>
2022-03-22 04:22:47 +08:00
```
Added Quotes Documentation (#2722)
2022-03-19 22:27:59 +08:00
{
"text": "[quote]",
"source": "[source]",
"id": [number of the quote]
"length": [number of characters in quote]
}
```
v1.14.1 (#2745) * updated default config to fix incorrect font button being highlighted * Convert account controller to ts (#2731) * using modular sdk * removing last script * replacing more code * unused code * removed unused code * removed unused code * importing auth * using analytics controller * importing auth and analytics * importing auth * updated git ignore * fixed path * removed live config from gitignore * added error message when failing to initialize firebase * added live config using live config when building production * removed unused code * fixed incorrect function use * added example config * added a step to the contributing guide * optional steps * fixed path * using example in source code so that github actions dont cry like little babies * using function correctly * using function correctly * ignoring live * removed * added action webpack config * bruce said "no-no" This reverts commit 0a1e5e1660200fe30378d36cb6778772e2f79cc8. * Fix * Add ignore * updated instructions * using correct functions * using correct function * missing parameter * using correct function * using correct function * removed ts ignores * using new functions * removed refresh * using new functions * merge fix * fixed merge * regenereated lockfile * using correct function * defaulting to the email thats already entered * storing default snap in a file * optional parameter * made parameters non optional * converted file to ts * removed unused parameters * removed unnecessary optional chaining * destructuring array * added a function to create error message * removed type * removed duplicate gitignore * removed no check Co-authored-by: Bruception <bberr022@fiu.edu> * Include dev branch in CI (#2739) * Decreased filesize and introduced chunk splitting (#2732) Rizwanmustafa * Decreased filesize * Introduce splitting for vendors * Added HTML webpack plugin for dynamic change of chunkhash and minification on production * Added bundle analyzer plugin for webpack * Prevent analyzer from opening on its own * updated contributors list * Package lock update * Created separate webpack config for analysing bundle * Standardize paths in webpack base config * Added devtool in dev webpack config * Minor issues * Based audit config off of the production config, saved exact packages and renamed some constants * Saved exact version of packages * Rename Config * Added intellisense for webpack configs * Added script for using audit config * Simple changes * Removed unnecessary cd and replaced webpack with npx wepback * added npm script accessible from root dir since audit is now a separate script, reenabled auto opening Co-authored-by: Miodec <bartnikjack@gmail.com> * Enable live reloading (#2738) bruception * Enable live reloading * Update scripts and documentation * Fix resolve * Use resolve * Fix layoutfluid timer warnings (#2740) Ferotiq * reduced date-fns import size * using inline source map so that code is debuggable * removed tinycolor2 dependency * Migrate Chart.js to 3.7.1 (#2735) DanGonite57 * Migrate Chart.js to 3.7.1 * Show funbox label with StartGraphsAtZero disabled * Fix label positioners * Include dev branch in CI (#2739) * Remove draw animation * Avoid RangeError with no data * Disable account chart initial render animation * Add temporary type assertion for options.animation * Test disabling animations via updateColors * Test re-update chart after resetting animation duration * Test dataset specific animation duration * Disable animations for now * Remove unused annotation Co-authored-by: Bruce Berrios <58147810+Bruception@users.noreply.github.com> * installed dev dependency to stop audit from complaining * removed mr mime dev dependency regenerate package-lock * not updating live burst when its disabled * using vanilla js to increase performance * updating chart once instead of 3 times * made log async * increased minimum wordset length to disable repeating words to 4 this stops infinite A B C sequences closes #2742 * increased tick padding * added some padding to stop data points from being cut off * fixed account graphs not being responsive * removed unnecessary style * updated button active color * Server version (#2746) Bruception * Add server version * typo * Fix logic * Moved to utility * Actually save version * Move logic order * updated metric name * removed unnecessary else Co-authored-by: Bruception <bberr022@fiu.edu> Co-authored-by: Bruce Berrios <58147810+Bruception@users.noreply.github.com> Co-authored-by: Rizwan Mustafa <rizwanmustafa0000@gmail.com> Co-authored-by: Evan <64989416+Ferotiq@users.noreply.github.com> Co-authored-by: DanGonite57 <danzinc57@gmail.com>
2022-03-22 04:22:47 +08:00
Added Quotes Documentation (#2722)
2022-03-19 22:27:59 +08:00
(If the language does exist in Monkeytype, but there are no quotes for it create a new file for the language)
v1.14.1 (#2745) * updated default config to fix incorrect font button being highlighted * Convert account controller to ts (#2731) * using modular sdk * removing last script * replacing more code * unused code * removed unused code * removed unused code * importing auth * using analytics controller * importing auth and analytics * importing auth * updated git ignore * fixed path * removed live config from gitignore * added error message when failing to initialize firebase * added live config using live config when building production * removed unused code * fixed incorrect function use * added example config * added a step to the contributing guide * optional steps * fixed path * using example in source code so that github actions dont cry like little babies * using function correctly * using function correctly * ignoring live * removed * added action webpack config * bruce said "no-no" This reverts commit 0a1e5e1660200fe30378d36cb6778772e2f79cc8. * Fix * Add ignore * updated instructions * using correct functions * using correct function * missing parameter * using correct function * using correct function * removed ts ignores * using new functions * removed refresh * using new functions * merge fix * fixed merge * regenereated lockfile * using correct function * defaulting to the email thats already entered * storing default snap in a file * optional parameter * made parameters non optional * converted file to ts * removed unused parameters * removed unnecessary optional chaining * destructuring array * added a function to create error message * removed type * removed duplicate gitignore * removed no check Co-authored-by: Bruception <bberr022@fiu.edu> * Include dev branch in CI (#2739) * Decreased filesize and introduced chunk splitting (#2732) Rizwanmustafa * Decreased filesize * Introduce splitting for vendors * Added HTML webpack plugin for dynamic change of chunkhash and minification on production * Added bundle analyzer plugin for webpack * Prevent analyzer from opening on its own * updated contributors list * Package lock update * Created separate webpack config for analysing bundle * Standardize paths in webpack base config * Added devtool in dev webpack config * Minor issues * Based audit config off of the production config, saved exact packages and renamed some constants * Saved exact version of packages * Rename Config * Added intellisense for webpack configs * Added script for using audit config * Simple changes * Removed unnecessary cd and replaced webpack with npx wepback * added npm script accessible from root dir since audit is now a separate script, reenabled auto opening Co-authored-by: Miodec <bartnikjack@gmail.com> * Enable live reloading (#2738) bruception * Enable live reloading * Update scripts and documentation * Fix resolve * Use resolve * Fix layoutfluid timer warnings (#2740) Ferotiq * reduced date-fns import size * using inline source map so that code is debuggable * removed tinycolor2 dependency * Migrate Chart.js to 3.7.1 (#2735) DanGonite57 * Migrate Chart.js to 3.7.1 * Show funbox label with StartGraphsAtZero disabled * Fix label positioners * Include dev branch in CI (#2739) * Remove draw animation * Avoid RangeError with no data * Disable account chart initial render animation * Add temporary type assertion for options.animation * Test disabling animations via updateColors * Test re-update chart after resetting animation duration * Test dataset specific animation duration * Disable animations for now * Remove unused annotation Co-authored-by: Bruce Berrios <58147810+Bruception@users.noreply.github.com> * installed dev dependency to stop audit from complaining * removed mr mime dev dependency regenerate package-lock * not updating live burst when its disabled * using vanilla js to increase performance * updating chart once instead of 3 times * made log async * increased minimum wordset length to disable repeating words to 4 this stops infinite A B C sequences closes #2742 * increased tick padding * added some padding to stop data points from being cut off * fixed account graphs not being responsive * removed unnecessary style * updated button active color * Server version (#2746) Bruception * Add server version * typo * Fix logic * Moved to utility * Actually save version * Move logic order * updated metric name * removed unnecessary else Co-authored-by: Bruception <bberr022@fiu.edu> Co-authored-by: Bruce Berrios <58147810+Bruception@users.noreply.github.com> Co-authored-by: Rizwan Mustafa <rizwanmustafa0000@gmail.com> Co-authored-by: Evan <64989416+Ferotiq@users.noreply.github.com> Co-authored-by: DanGonite57 <danzinc57@gmail.com>
2022-03-22 04:22:47 +08:00
### Committing Quotes
Added Quotes Documentation (#2722)
2022-03-19 22:27:59 +08:00
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:
<img width="1552" alt="Screenshot showing how to update the fork to match the main Monkeytype repository" src="https://user-images.githubusercontent.com/83455454/149186547-5b9fe4fd-b944-4eed-a959-db43f96198bf.png">
Create a pull request:
<img width="1552" alt="Screenshot showing how to create a pull request to the main Monkeytype repository" src="https://user-images.githubusercontent.com/83455454/149186637-66dae488-05ae-45c4-9217-65bc36c4927b.png">
## Quote Guidelines
Make sure your quote(s) follows the quote guidelines.
[Quote guidelines](https://github.com/Miodec/monkeytype/blob/master/CONTRIBUTING.md#quote-guidelines)
Reference in a new issue Copy permalink