Skip to content

Latest commit

Β 

History

History
327 lines (254 loc) Β· 15.7 KB

CONTRIBUTING.md

File metadata and controls

327 lines (254 loc) Β· 15.7 KB

Contributing

πŸ‘πŸŽ‰ First off, thanks for taking the time to contribute! πŸŽ‰πŸ‘

Table Of Contents

Contribute to the Website

Website Suggestions

  • Slightly darker shade for the navbar.
  • Add better router navigation: Make every view unique by adding support in the URL. This allows sharing the link and seeing what was shared, common items sharing the same link isn't good.

Future Ideas

  • User profile with statistics such as the WPM and learning progress.
  • Show the image for each definition.
  • Add support for multiple images by using slideshow.
  • Enlarge the image on hover.
  • Allow to hide attributes: These may include the image, notes, synonyms, etc.
  • Click on a word anywhere on the website and get taken to the meaning if it exists.
  • 2 folders for images, one containing small 250 x 250 images and one containing large 750 x 750 images. The large ones are for enlarged images which get shown on hover. The preprocessing helps to load the images faster as some images are super large and take time to load otherwise.
  • Typing test which contains just the words alone to test for spelling and reiterate the definition in your head.
  • Show the user the number of corrections that were made and the number of errors that were made.
  • Keyboard shortcut buttons to do things such as play audio (US/UK), next word, previous word, etc.
  • For self-evaluation of spelling or the spell-check component: press enter upon completion of word to make sure the user can't correct it if the actual word is longer, this allows for false positives.
  • If the user types the spelling incorrectly, give him an option to practice by typing the word 5 times.
  • Show the words the user has typed incorrectly, maybe with a click of a button.
  • Summarize the results at the end of completing a set.
    • Show the average WPM
    • Show the total time taken
    • Show the incorrect words
    • Show the average accuracy
  • Allow the user to flag certain words for review later.
  • Allow the user to add a word just by typing it. Perhaps you can fetch all the information like the definition, synonyms, antonyms, example, etc. from sources.
  • Deal with words which are duplicate of each other in terms of parts of speech. For example, Pollyanna and Pollyannaish.

Must-add Features

  • Navbar should be fixed when scrolling the page.
  • Login page with user authentication.
  • Show if the Caps Lock key is on/off.
  • Chart.js, show the value of WPM on hover.
  • Upon completion of a set, add an alert box stating "Set Completed. Would you like to move to the next set?" with Yes/No button.
  • Control menu with options to select what to type or show in the UI (key, pos, def, synonyms, antonyms, and notes).
  • Test section where the user hears the audio of a word and needs to type it. Helps wire the spelling of different words in the head.
  • Search functionality doesn't work for words containing accents (both in scripts and on website, for example, prΓ©cis).
  • Remove extra words that have the same word root but in a different part of speech (discern, discerning, discernment).
  • Ability to search using alternatives.

Provide or Handle Bugs! πŸͺ²

Word List Component

  • Loads slightly lower in terms of the page.

Word Item Component

  • In the reading view, clicking the audio of some card below scrolls to the first word. This can be fixed by making the index a query parameter in the url and only scroll when you see a query parameter.
  • Go to elusive, then the word dragonflies in the Notes, the characters f and l are different span tags with different stylings but show up together as one πŸ˜•. Type f correctly but l incorrectly, both will be green but the classes are applied correct and incorrect which is right! Could be the width of the background color? I am not sure.
  • The current letter underline doesn't work for all, such as commas.
  • The current letter underline is too small to be noticed when the width of the character is small, for example, the character )
  • When switching to learning mode, the card is at the top of the screen (you can't see the text Learning Mode), and on incorrect letter, the card scrolls up for some reason.
  • When full screen (can be done by pressing F11 on Windows), if you type an incorrect letter, the page shifts right.
  • When a single line breaks over to the next line, hitting enter instead of space doesn't show an error when there is an error. You can verify this by inspecting the span tags and the (space) will have the incorrect class applied, but it doesn't show on the card. The user sees the Accuracy has gone down when according to him he did not make an error.
  • Upon completion of word, pressing backspace also takes you to the next word (or set) when only hitting the enter key should work.
  • There are non-ascii characters that need to be converted to the corresponding ascii characters when typing. Check the word empathetic, it has an em dash and a quotation mark, these need to be mapped to hyphen and single quote.
  • When in keyOnly mode, many words get taken as 0 WPM, try typing modicum extremely fast and you will notice this behaviour.
  • When in not keyOnly mode, typing till the definition and then switching to keyOnly causes a bug where it doesn't do anything, it's like typing without any checks.

fetch.py

  • The incorrect audio pronunciation and IPA phonetics gets downloaded for some words. For example, vacillating gets the audio and phonetics of vacillate. This is because on cambridge the word vacillating is present at the top hence passing the key check, but the audio files and phonetics are down from vacillate and those incorrectly get downloaded.

Bestow or Improve Images πŸ–ΌοΈ

Common Words 1

  • banal: same image used as hackneyed.
  • construe
  • parsimonious

Common Words 2

  • betray: same as perfidy.
  • predilection
  • platitude: same image as conspicuous.
  • vociferous: better definition without vehement?

Common Words 3

  • abstain: same image as eschew.
  • ascetic: noun definition uses the word, then it's not a definition now is it?
  • delineate: add a note stating the importance of a portrait drawing for criminal investigation.
  • denote
  • derivative: not all people wil realize it's Mona lisa, so either find a similar better image or add a note.
  • fallacious: a better image would reflect the clause if A then B, A, therefore B but the assumption of A itself was wrong.
  • supplant: assumes the user knows the meaning of the word supersede, bear in mind these are common words.
  • treacherous: for the second word, add an image for a dangerous bridge which may collapse.
  • vilify: same image as recrimination.

Common Words 4

  • implausible: same image as antipathy.
  • injunction: feels like justice rather than an order.
  • intransigent: add a note about the KKK.
  • pragmatic: feels like emotions instead of theory, however, knowledge vs experience should be the goal. Also the same image as cerebral.
  • provincial

Common Words 5

  • austere
  • dilettante: doesn't make much sense and also same image as unpropitious.
  • garrulous: seems angry rather than talkative.
  • insolent: same image as frivolous.
  • intrepid: change definition to synonym and add an actual definition.
  • lionize: paparazzi or something similar would be nice, and when the photo was taken is irrelevant.
  • ostracize: the image doesn't make much sense and is of bad quality.

Common Words 6

  • banality: same image as hackneyed.
  • harried: the image doesn't depict people wanting things from you.
  • indecorous: add a note that using a phone while eating is bad manners?
  • maladroit: feels like hasty but it means not clever or skillful?
  • pejorative: feels like you shouldn't speak when in reality it means to express contempt.
  • specious: the image is bad, and the second definition can be used for the image. Also, isn't it a synonym for spurious?

Common Words 7

  • panache: same image as illustrious.
  • placate: some image as mollify.

Basic Words 1

  • indignant: add a note about George Floyd.
  • inundate
  • retiring: doesn't depict the person likes being alone.
  • tawdry: looks poor quality and cheap but isn't showy, you wanna have both.
  • telling
  • unnerve: doesn't show the height isn't really much, maybe one where the person is afraid of drowning in a shallow pool.

Basic Words 2

  • cogent: same image as posit.
  • errant
  • extenuating: the image could be improved.
  • immaterial
  • junta: the audio pronunciation doesn't match the phonetics.
  • lassitude: add word to this set.
  • misanthrope
  • moment: maybe an image which changes the life of a person and that moment was captured.
  • replete: add a note stating the shop in the image is a supermarket?
  • sanctimonious: the picture depicts the meaning of protecting something sacred, but we want something along the lines of making a show of being holy.
  • unconscionable: Magoosh has a different meaning.

Basic Words 3

  • appreciable
  • boon: add a note stating why microwave is a boon and how it changed?
  • consummate: could also mean sculpting, consequently, an image of sculpting?
  • fledgling: maybe switch the definition to synonyms and use an actual definition?
  • flounder: it also denotes having difficulties for a task.
  • moot: an image which says What came first the chicken or the egg?
  • muted
  • obdurate
  • resolve: different meaning in Magoosh.

Basic Words 4

  • buck: add word to this set.
  • conducive
  • credence
  • detrimental: an actual image instead of a portrait would be nice.
  • empathetic: has an em dash and the single-quote ' isn't a regular singe-quote.
  • facetious: different meaning in Magoosh.
  • glib: the image isn't memorable.
  • grovel: same image used for obsequious.
  • impeccable
  • irresolute: the image doesn't show the notion of being hesitant, but rather, shows confused.

Basic Words 5

  • abysmal
  • balk
  • colossal: a similar image is used for prodigious.
  • complacent: the image just looks like he's rich, also different meaning in Magoosh representing being happy with failure.
  • placid
  • savvy
  • unseemly: same image used for derivative.
  • begrudge: the image doesn't make too sense.
  • cavalier
  • emulate
  • glean
  • implicate
  • inarticulate: even worse handwriting would depict it better.
  • incumbent
  • intermittent
  • rakish: same image as raffish.
  • veneer: it's hard to notice the thin layer.

Basic Words 6

  • antedate: (US) audio pronunciation sounds like atedate.
  • carping: (US) (UK) the audio pronunciation and phonetics is of carp when the word is carping. Also, the image seems more as scolding but again faultfinding is hard to describe.
  • cavalier: the image doesn't make much sense.
  • redress: same as venal and the image looks more like corruption when it should be giving money to help and fix a mistake.

Basic Words 7

  • badger: could use this image for tout which means selling something, consequently, fetching a new image for this as well.
  • contemptuous
  • deliberate
  • embroiled: (US) (UK) the audio pronunciation is of embroil and not embroil-ed
  • resignation: same image as concede.
  • serendipity: add a note about penicillin.

Advanced Words 1

  • abrogate
  • churlish: feels like you are attacking someone.
  • conciliate: feels like you are forming peace.
  • despot: (US) the audio pronunciation sounds like despit.
  • diatribe: the image of churlish can be used here.
  • exegesis
  • saturnine
  • vicissitude: we don't want text, we want visual images.

Advanced Words 2

  • benighted: feels confused and frustrated instead of without morals or knowledge.
  • diminutive: an image with a name such as Sam-uel where uel is greyed out.
  • dissemble: the idea is nice, maybe an image where you can see the gun more clearly.
  • dissipate: throwing money in all directions would cover both the definitions.
  • excoriate: (US) the audio sounds like exgoriate.
  • hedge: the image should should depict restricting not dodging.
  • jaundice: the image doesn't really make sense.
  • peremptory
  • Pollyanna: handle the capital letter in spell-check.
  • Pollyannaish: handle the capital letter in spell-check.
  • Pollyannaish: (US) the audio pronunciation is lower than the usual volume.
  • sententious
  • tendentious: white lives matter isn't exactly controversial.

Advanced Words 3

  • litany: same image used for exorbitant.
  • mordant
  • pecuniary: more elaborate definition would be nice.
  • probity: textual image to visual image, (US) the audio pronunciation sounds like probidy.
  • recapitulation: convert textual image to visual image.

Advanced Words 4

  • intimation
  • machinate: the audio pronunciations are swapped, US to UK and vice-versa.
  • unflappable: there's no crisis shown in the picture.
  • untenable: the image shows the opposite meaning.

Advanced Words 5

  • appurtenant: visually the exact same image as obliging, only color difference.
  • bemoan: the picture just means sad, but the word means to express discontent or a strong regret.
  • bristle
  • browbeat: same image as banish, could definitely use a better image.
  • effervescent: the image doesn't contain much excitement?
  • epigram: a clever and amusing idea would be nice.
  • ersatz: (US) the audio pronunciation sounds like ertsatz, notice the additional t.
  • inanity: an image that means the lack of meaning or ideas.
  • pith: (US) the audio sounds like piff.

Advanced Words 6

  • assiduously: the image could be better used for another word, for example, fecund.
  • ethereal: the image doesn't reflect the idea of extremely light and delicate.
  • fecund: use the image of assiduously.
  • impugn: the image works much better for impute, you need something else here.
  • malingerer: a person sleeping in a suit would work better.
  • panegyric: there is no speech in the picture.
  • pontificate: the image doesn't make sense.
  • self-effacing: handle the hyphen in spell-check.

Advanced Words 7

  • anathema: (US) the audio pronunciation is slower than usual.
  • apotheosis: same as aesthetic.
  • estimable: same image is used for deferential.
  • extrapolate
  • graft: same image used as venality.
  • infelicitous: maybe it's used more conceptually rather than for actual events?
  • misattribute: (US) the audio sound is slightly lower than usual.
  • modicum: an even smaller diamond ring?
  • perfunctory: an image where the guy is annoyed but still does the work, would definitely describe it better.
  • trenchant: the image doesn't describe it too well.
  • verisimilitude: It's a good image, but maybe conceptually means that it is indeed true and not seeming to be true but false?
  • veritable: a bad image example.

Personal Words 9

  • obturate: (UK) the audio pronunciation and phonetics doesn't match up. The phonetic was taken from Google while the audio was taken from audioenglish.

Personal Words 10

  • uproarious: the definitions uses the word, nullifying the purpose of a definition

PrepScholar Words 1

  • covet: use a better image.

Extra Words

  • notorious