diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index d040161513aa..0001b5c5d4ce 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -27,7 +27,7 @@ Below is a set of general guidelines for different types of changes. ### Pull Request Naming Guidelines -We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for our pull request titles (and commit messages on the master branch) and also include the author name at the end inside parenthesis. Please follow the guidelines below when naming pull requests. +We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for our pull request titles (and commit messages on the master branch) and also include the author name at the end inside parentheses. Please follow the guidelines below when naming pull requests. For types, we use the following: @@ -54,7 +54,7 @@ For types, we use the following: -Before submitting a theme make sure... +Before submitting a theme, make sure... - your theme is unique and isn't visually similar to any we already have. - the text color is either black or white (or very close to these colors) @@ -91,4 +91,4 @@ If you want to contribute layouts but don't know how, check [LAYOUTS.md](/docs/L ## 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/monkeytypegame/monkeytype/discussions) and a contributor will be happy to assist you. +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/monkeytypegame/monkeytype/discussions) and a contributor will be happy to assist you. diff --git a/docs/CONTRIBUTING_ADVANCED.md b/docs/CONTRIBUTING_ADVANCED.md index 242e1940023a..25e982477d73 100644 --- a/docs/CONTRIBUTING_ADVANCED.md +++ b/docs/CONTRIBUTING_ADVANCED.md @@ -46,7 +46,7 @@ You can use docker to run the frontend and backend. This will take care of OS-sp ### Firebase (optional) -The account system will not let you create an account without a Firebase project. You can skip this if you don't think you will need it (you can always set it up later) +The account system will not let you create an account without a Firebase project. You can skip this if you don't think you will need it (you can always set it up later). 1. Create a Firebase account if you already haven't done so. 1. [Create a new Firebase project.](https://console.firebase.google.com/u/0/) @@ -79,7 +79,7 @@ The account system will not let you create an account without a Firebase project ### Config file -Within the `frontend/src/ts/constants` directory, duplicate `firebase-config-example.ts`, rename it to `firebase-config.ts` +Within the `frontend/src/ts/constants` directory, duplicate `firebase-config-example.ts`, rename it to `firebase-config.ts`. - If you skipped the Firebase step, you can leave the fields blank - Otherwise: @@ -101,10 +101,9 @@ BACKEND_URL="http://:5005" Follow these steps if you want to work on anything involving the database/account system. Otherwise, you can skip this section. 1. Inside the backend folder, copy `example.env` to `.env` in the same directory. - - The backend Docker scripts read port bindings from this file. If `27017`, `6379`, or `5005` are already in use on your machine, update `DOCKER_DB_PORT`, `DOCKER_REDIS_PORT`, and `DOCKER_SERVER_PORT` before starting Docker. -2. Setup the database server +2. Set up the database server | Manual | Docker (recommended) | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -150,7 +149,7 @@ If you are on a UNIX system and you get a spawn error, run npm with `sudo`. ## Standards and Guidelines -Code formatting and linting is enforced by [Oxc (Oxfmt and Oxlint)](https://github.com/oxc-project/oxc), which automatically runs every time you make a commit. +Code formatting and linting are enforced by [Oxc (Oxfmt and Oxlint)](https://github.com/oxc-project/oxc), which automatically runs every time you make a commit. 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. diff --git a/docs/CONTRIBUTING_BASIC.md b/docs/CONTRIBUTING_BASIC.md index 2d46dc93a73f..fade85b27a0c 100644 --- a/docs/CONTRIBUTING_BASIC.md +++ b/docs/CONTRIBUTING_BASIC.md @@ -41,7 +41,7 @@ There are two methods for making a change in the code. #### Option 1 - Visual Studio Code Web Editor (Recommended) -If you are not a developer and wish to contribute themes, new languages, or quotes, having a text editor will make contributions _much_ easier. To make complex edits without installing anything, we recommend using GitHub's VS Code web editor. In your fork of Monkeytype (fork it first), go to the `Code` tab of the repo and press .(the period/dot key). This will open up the repo in an online VS Code instance you can use to edit files in the browser. Once you are done making your changes, go to the Source Control tab in the activity bar with Ctrl/Cmd + Shift + G, click the `+` next to the files you've changed to stage them, type a brief message summarizing the changes made in the commit, and press Ctrl/Cmd + Enter to commit your changes to your fork. +If you are not a developer and wish to contribute themes, new languages, or quotes, having a text editor will make contributions _much_ easier. To make complex edits without installing anything, we recommend using GitHub's VS Code web editor. In your fork of Monkeytype (fork it first), go to the `Code` tab of the repo and press . (the period/dot key). This will open up the repo in an online VS Code instance you can use to edit files in the browser. Once you are done making your changes, go to the Source Control tab in the activity bar with Ctrl/Cmd + Shift + G, click the `+` next to the files you've changed to stage them, type a brief message summarizing the changes made in the commit, and press Ctrl/Cmd + Enter to commit your changes to your fork. Once done, move on to the [next section to create a pull request](#creating-a-pull-request). @@ -53,7 +53,7 @@ You're now ready to make a change. Navigate to the file that you're looking to c 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. @@ -77,7 +77,7 @@ Once up to date, you can click the `Contribute` button to open a PR. Create a pull request: Screenshot showing how to create a pull request to the main Monkeytype repository -Be sure to add a good description to the PR and that the source and destination branches at the top look correct. The `base repository` and `base branch` should be listed as `monkeytypegame/monkeytype` and `master` respectively, and on the right of that should be your forked repository and the branch you have your changes on. +Be sure to add a good description to the PR and ensure that the source and destination branches at the top look correct. The `base repository` and `base branch` should be listed as `monkeytypegame/monkeytype` and `master` respectively, and on the right of that should be your forked repository and the branch you have your changes on. Once done, click on `Create pull request` to officially publish your PR. @@ -89,4 +89,4 @@ Once your PR is approved, all that is left to do is merge it! ## Questions -If you have any questions, comments, concerns, or problems, don't hesitate to let us know via [email](mailto:jack@monkeytype.com)(to Miodec), on [GitHub](https://github.com/monkeytypegame/monkeytype/discussions) or on [Discord](https://discord.gg/monkeytype) in the [`#development`](https://discord.com/channels/713194177403420752/713196019206324306) channel and a contributor will be happy to assist you. +If you have any questions, comments, concerns, or problems, don't hesitate to let us know via [email](mailto:jack@monkeytype.com) (to Miodec), on [GitHub](https://github.com/monkeytypegame/monkeytype/discussions) or on [Discord](https://discord.gg/monkeytype) in the [`#development`](https://discord.com/channels/713194177403420752/713196019206324306) channel and a contributor will be happy to assist you. diff --git a/frontend/src/ts/components/pages/AboutPage.tsx b/frontend/src/ts/components/pages/AboutPage.tsx index d80be6029b59..b81984fa722d 100644 --- a/frontend/src/ts/components/pages/AboutPage.tsx +++ b/frontend/src/ts/components/pages/AboutPage.tsx @@ -194,7 +194,7 @@ export function AboutPage(): JSXElement { 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 keyboard typing during a typing test, by + experience of natural keyboard 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.