From ff27a5d599d681b1c5dc045d938390bd3bcf4625 Mon Sep 17 00:00:00 2001 From: Ranjit Raut <67329253+theranjitraut@users.noreply.github.com> Date: Mon, 23 Oct 2023 15:51:09 +0000 Subject: [PATCH] docs: fix typos and grammatical errors (theranjitraut) (#4728) * some typos are fixed * some typoes are fixed in CODE_OF_CONDUCT.md * typos are fixed in CONTRIBUTING_ADVANCED.md * CONTRIBUTING_BASIC.md typos updated * LANGUAGES.md typos are fixed * Update CONTRIBUTING.md --- CODE_OF_CONDUCT.md | 8 ++++---- CONTRIBUTING.md | 6 +++--- CONTRIBUTING_ADVANCED.md | 14 +++++++------- CONTRIBUTING_BASIC.md | 14 +++++++------- LANGUAGES.md | 8 ++++---- README.md | 6 +++--- 6 files changed, 28 insertions(+), 28 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index dbb29799b..f509eaab9 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -3,7 +3,7 @@ ## Our Pledge -We as members, contributors, and leaders pledge to make participation in our +We as members, contributors, and leaders pledge to participate in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, @@ -16,7 +16,7 @@ diverse, inclusive, and healthy community. ## Our Standards Examples of behavior that contributes to a positive environment for our -community include: +community includes: * Demonstrating empathy and kindness toward other people * Being respectful of differing opinions, viewpoints, and experiences @@ -34,7 +34,7 @@ Examples of unacceptable behavior include: * Public or private harassment * Publishing others' private information, such as a physical or email address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a +* Other conduct that could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities @@ -51,7 +51,7 @@ decisions when appropriate. ## Scope -This Code of Conduct applies within all community spaces, and also applies when +This Code of Conduct applies within all community spaces and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1fd384fb5..b803577d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,7 +16,7 @@ When contributing to Monkeytype, it's good to know our best practices, tips, and ## How to Contribute -We have two separate contribution guides based on what you're looking to contribute. If you're simply looking to help us augment our language or quotes data, please refer to [CONTRIBUTING_BASIC.md](./CONTRIBUTING_BASIC.md). This guide will go over how to do so easily, and without the need to set up a local development server. +We have two separate contribution guides based on what you're looking to contribute. If you're simply looking to help us augment our language or quotes data, please refer to [CONTRIBUTING_BASIC.md](./CONTRIBUTING_BASIC.md). This guide will go over how to do so easily and without the need to set up a local development server. If you're looking to make deeper code changes that affect functionality, or will require screenshots of the changes, please refer to [CONTRIBUTING_ADVANCED.md](./CONTRIBUTING_ADVANCED.md). @@ -34,7 +34,7 @@ For types, we use the following: - `impr`: An improvement to an existing feature - `fix`: A bug fix - `docs`: Documentation only changes -- `style`: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) +- `style`: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc) - `refactor`: A code change that neither fixes a bug nor adds a feature, but makes the code easier to read, understand, or improve - `perf`: A code change that improves performance - `test`: Adding missing tests or correcting existing tests @@ -67,7 +67,7 @@ Before submitting a theme make sure... ### Quote Guidelines -- Do not include content that contains any libelous or otherwise unlawful, abusive or obscene text. +- Do not include content that contains any libelous or otherwise unlawful, abusive, or obscene text. - Ensure that your contribution meets JSON standards (no trailing comma at the end of a list) - Verify quotes added aren't duplicates of any already present - Verify the `length` property is correct (length of the text in characters) diff --git a/CONTRIBUTING_ADVANCED.md b/CONTRIBUTING_ADVANCED.md index 9bf807b6f..d3bfdf0d7 100644 --- a/CONTRIBUTING_ADVANCED.md +++ b/CONTRIBUTING_ADVANCED.md @@ -14,13 +14,13 @@ ## Prerequisites -This contribution guide is for cases in which you need to test the functionality of your changes, or if you need to take screenshots of your changes. You will need a computer with a stable internet connection, a text editor, Git, and NodeJS with version 18.17.1. There are some additional requirements depending on what you're looking to contribute, such as Firebase for authentication, Mongo and Docker for the backend. Read the below sections to understand how to set up each of these tools. +This contribution guide is for cases in which you need to test the functionality of your changes, or if you need to take screenshots of your changes. You will need a computer with a stable internet connection, a text editor, Git, and NodeJS with version 18.17.1. There are some additional requirements depending on what you're looking to contribute, such as Firebase for authentication, and Mongo and Docker for the backend. Read the below sections to understand how to set up each of these tools. ### Git **IMPORTANT: If you are on Windows, run `git config --global core.autocrlf false` before cloning this repo to prevent CRLF errors.** -Git is optional but we recommend you utilize it. Monkeytype uses the Git source control management (SCM) system for its version control. Assuming you don't have experience typing commands in the command line, we suggest installing [Sourcetree](https://www.sourcetreeapp.com/). You will be able to utilize the power of Git without needing to remember any cryptic commands. Using a Git client such as Sourcetree won't give you access to the full functionality of Git, but provides an easy to understand graphical user interface (GUI). Once you have downloaded Sourcetree, run the installer. While installing Sourcetree, keep your eyes peeled for the option to also install Git with Sourcetree. This is the option you will need to look for in order to install Git. **Make sure to click yes in the installer to install Git with Sourcetree.** +Git is optional but we recommend you utilize it. Monkeytype uses the Git source control management (SCM) system for its version control. Assuming you don't have experience typing commands in the command line, we suggest installing [Sourcetree](https://www.sourcetreeapp.com/). You will be able to utilize the power of Git without needing to remember any cryptic commands. Using a Git client such as Sourcetree won't give you access to the full functionality of Git, but provides an easy-to-understand graphical user interface (GUI). Once you have downloaded Sourcetree, run the installer. While installing Sourcetree, keep your eyes peeled for the option to also install Git with Sourcetree. This is the option you will need to look for in order to install Git. **Make sure to click yes in the installer to install Git with Sourcetree.** ### NodeJS and NPM @@ -32,7 +32,7 @@ Alternatively, you can navigate to the NodeJS [website](https://nodejs.org/en/) ### Docker (Recommended but Optional) -You can use docker to run the frontend and backend. This will take care of OS specific problems, but might be a bit more resource intensive. You can download it from the [Docker website](https://www.docker.com/get-started/#h_installation). +You can use docker to run the frontend and backend. This will take care of OS-specific problems but might be a bit more resource-intensive. You can download it from the [Docker website](https://www.docker.com/get-started/#h_installation). ### Firebase (optional) @@ -48,7 +48,7 @@ The account system will not let you create an account without a Firebase project - In the Firebase console, go to `Authentication > Sign-in method` - Click on `Email/Password`, enable it, and save - - Click on `Google`, add a support email and save + - Click on `Google`, add a support email, and save 1. Generate a Firebase Admin private key (optional, only needed if you want to work on the backend) @@ -57,10 +57,10 @@ The account system will not let you create an account without a Firebase project - Save as `serviceAccountKey.json` inside the `backend/src/credentials/` directory. 1. Run `npm install -g firebase-tools` to install the Firebase Command Line Interface. -1. Run `firebase login` on your terminal to log in to the same google account you just used to create the project. +1. Run `firebase login` on your terminal to log in to the same Google account you just used to create the project. 1. Within the `frontend` directory, duplicate `.firebaserc_example`, rename the new file to `.firebaserc` and change the project name to the firebase project id you just created. - - Run `firebase projects:list` to find your firebase project id. + - Run `firebase projects:list` to find your firebase project ID. - If `.firebaserc_example` does not exist after cloning, create your own with: ```.firebaserc @@ -141,7 +141,7 @@ Note: Rebuilding doesn't happen instantaneously and depends on your machine, so Code style is enforced by [Prettier](https://prettier.io/docs/en/install.html), which automatically runs every time you make a commit. -For guidelines on commit messages, adding themes, languages or quotes, pleases refer to [CONTRIBUTING.md](./CONTRIBUTING.md). Following these guidelines will increase the chances of getting your change accepted. +For guidelines on commit messages, adding themes, languages, or quotes, please refer to [CONTRIBUTING.md](./CONTRIBUTING.md). Following these guidelines will increase the chances of getting your change accepted. ## Questions diff --git a/CONTRIBUTING_BASIC.md b/CONTRIBUTING_BASIC.md index b00b06070..dcb9895d4 100644 --- a/CONTRIBUTING_BASIC.md +++ b/CONTRIBUTING_BASIC.md @@ -17,19 +17,19 @@ This file details how to create basic contributions to Monkeytype purely through Given the above, you should only be using this guide if you plan on making changes that do not impact the functionality of the website. Examples of such cases would be translation fixes, language additions, or quote additions. -For all other changes, please refer to [CONTRIBUTING_ADVANCED.md](./CONTRIBUTING_ADVANCED.md) to learn how to setup the necessary tools to develop on your local environment. +For all other changes, please refer to [CONTRIBUTING_ADVANCED.md](./CONTRIBUTING_ADVANCED.md) to learn how to set up the necessary tools to develop on your local environment. ### Prerequisites You must have a browser that can access GitHub, and possess a GitHub account. Once you have those two things, you're ready to move on to making your contribution(s)! -The steps for basic contributions are showcased splendidly in [this youtube video](https://www.youtube.com/watch?v=nT8KGYVurIU), so it is recommended you watch it. +The steps for basic contributions are showcased splendidly in [this YouTube video](https://www.youtube.com/watch?v=nT8KGYVurIU), so it is recommended you watch it. ## Contributing ### Forking Monkeytype -First you will have to obtain your own copy of the Monkeytype repository, also known as "forking". Click [here](https://github.com/monkeytypegame/monkeytype/fork) to open the fork wizard or go to the top right of your screen and then click the `fork` button. +First, you will have to obtain your own copy of the Monkeytype repository, also known as "forking". Click [here](https://github.com/monkeytypegame/monkeytype/fork) to open the fork wizard or go to the top right of your screen and then click the `fork` button. Screenshot showing location of the fork button on GitHub. @@ -37,7 +37,7 @@ This will create a clone of the repository under your own account. Navigate to y ### Making a Change -There are two methods to making a change in the code. +There are two methods for making a change in the code. #### Option 1 - Visual Studio Code Web Editor (Recommended) @@ -47,17 +47,17 @@ Once done, move on to the [next section to create a pull request](#creating-a-pu #### Option 2 - GitHub Web UI -You're now ready to make a change. Navigate to the file that you're looking to contribute to in your forked repository. Once you navigate to the file, you should see an `Edit` icon (shaped as a pencil) on the right: +You're now ready to make a change. Navigate to the file that you're looking to contribute to in your forked repository. Once you navigate to the file, you should see an `Edit` icon (shaped like a pencil) on the right: Screenshot showing how to edit files on the GitHub Web UI. Upon clicking this, you'll have the ability to edit the document itself. -_Note however that some files that are too large might not have this option. In these cases you will need to download the code and create edits outside of the GitHub web UI. Refer to [CONTRIBUTING_ADVANCED.md](./CONTRIBUTING_ADVANCED.md)_ +_Note however that some files that are too large might not have this option. In these cases, you will need to download the code and create edits outside of the GitHub web UI. Refer to [CONTRIBUTING_ADVANCED.md](./CONTRIBUTING_ADVANCED.md)_ At this point, you should take a look at [CONTRIBUTING.md](./CONTRIBUTING.md) to view guidelines for theme, language, and quote contributions. -Once you've completed your change, you're ready to commit them. At the bottom of the edit file screen, you will find the commit UI. In the first box, you want to put in a title that describes the change you made. Then in the description field, you can put in any additional detail to supplement your title further. +Once you've completed your change, you're ready to commit it. At the bottom of the edit file screen, you will find the commit UI. In the first box, you want to put in a title that describes the change you made. Then in the description field, you can put in any additional detail to supplement your title further. You will find two radio buttons, one prompts you to commit directly to your current branch, and the other prompts you to create a new branch for your commit and start a pull request. Select the first option to commit the change directly to your current branch. diff --git a/LANGUAGES.md b/LANGUAGES.md index 2d76a53d2..2cb551c68 100644 --- a/LANGUAGES.md +++ b/LANGUAGES.md @@ -7,13 +7,13 @@ ### Forking Monkeytype -First you will have to make a personal copy of the Monkeytype repository, also known as "forking". Go to the [Monkeytype repo](https://github.com/monkeytypegame/monkeytype/) and then click the "fork" button. +First, you will have to make a personal copy of the Monkeytype repository, also known as "forking". Go to the [Monkeytype repo](https://github.com/monkeytypegame/monkeytype/) and then click the "fork" button. Screenshot showing location of the fork button on GitHub. ## Creating Languages -Once you have forked the repository you can now add your language. Create a new json file in `./frontend/static/languages/`, named as the language name and the number of words, e.g. `language_1k.json`. If there are less than 1,000 words, simply name the file after the language (e.g. `language.json`). Note that a minimum of 200 words are required. +Once you have forked the repository you can now add your language. Create a new JSON file in `./frontend/static/languages/`, named as the language name and the number of words, e.g. `language_1k.json`. If there are less than 1,000 words, simply name the file after the language (e.g. `language.json`). Note that a minimum of 200 words are required. The contents of the file should be as follows: @@ -28,7 +28,7 @@ The contents of the file should be as follows: ``` It is recommended that you familiarize yourselves with JSON before adding a language. For the `name` field, put the name of your language. `rightToLeft` indicates how the language is written. If it is written right to left then put `true`, otherwise put `false`. -`ligatures` A ligature occurs when multiple letters are joined together to form a character [more details](). If there's joining in the words, which is the case in languages like (Arabic, Malayalam, Persian, Sanskrit, Central_Kurdish... etc.), then set the value to `true`, otherwise set to `false`. For `bcp47` put your languages [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag). Finally, add your list of words to the `words` field. +`ligatures` A ligature occurs when multiple letters are joined together to form a character [more details](). If there's joining in the words, which is the case in languages like (Arabic, Malayalam, Persian, Sanskrit, Central_Kurdish... etc.), then set the value to `true`, otherwise set it to `false`. For `bcp47` put your languages [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag). Finally, add your list of words to the `words` field. In addition to the language file, you need to add your language to the `_groups.json` and `_list.json` files in the same directory. Add the name of the language to the `_groups.json` file like so: @@ -47,7 +47,7 @@ In addition to the language file, you need to add your language to the `_groups. }, ``` -The `languages` field is the list of files that you have created for your language (without the `.json` file extension). Make sure to add all your files if you have created multiple word lists of differing length in the same language. +The `languages` field is the list of files that you have created for your language (without the `.json` file extension). Make sure to add all your files if you have created multiple word lists of differing lengths in the same language. Add your language lists to the `_list.json` file like so: diff --git a/README.md b/README.md index 567d70b35..e6d46f613 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,14 @@ # About -Monkeytype is a minimalistic and customizable [typing test](https://www.monkeytype.com). It features many test modes, an account system to save your typing speed history, and user-configurable features such as themes, sounds, a smooth caret, and more. Monkeytype attempts to emulate the experience of natural typing during a typing test, by unobtrusively presenting the text prompts and displaying typed characters in-place, providing straightforward, real-time feedback on typos, speed, and accuracy. +Monkeytype is a minimalistic and customizable [typing test](https://www.monkeytype.com). It features many test modes, an account system to save your typing speed history, and user-configurable features such as themes, sounds, a smooth caret, and more. Monkeytype attempts to emulate a natural typing experience during a typing test by unobtrusively presenting the text prompts and displaying typed characters in place, providing straightforward, real-time feedback on typos, speed, and accuracy. # Features - minimalistic design, with optional advertisements and focus mode while typing - type what you see, see what you type - live errors, wpm, and accuracy displays -- variety of test lengths and languages +- a variety of test lengths and languages - punctuation and numbers modes - quotes - themes @@ -45,7 +45,7 @@ Before contributing to this repository, please read the [code of conduct](./CODE Everyone who provided valuable feedback on the [original Reddit post](https://www.reddit.com/r/MechanicalKeyboards/comments/gc6wx3/experimenting_with_a_completely_new_type_of/) for the prototype of this website. -All of the [contributors](https://github.com/monkeytypegame/monkeytype/graphs/contributors) that have helped with implementing various features, adding themes, fixing bugs, and more. +All of the [contributors](https://github.com/monkeytypegame/monkeytype/graphs/contributors) have helped implement various features, add themes, fix bugs, and more. # Support