diff --git a/CONTRIBUTING_BASIC.md b/CONTRIBUTING_BASIC.md index ff05d1919..b00b06070 100644 --- a/CONTRIBUTING_BASIC.md +++ b/CONTRIBUTING_BASIC.md @@ -13,23 +13,23 @@ ### Basic Contributions -This file details how to create basic contributions to Monkeytype purely through the use of the Github web UI. This means you will not need to set up a local development environment of any kind; all you'll need is a browser that can access Github and an account. +This file details how to create basic contributions to Monkeytype purely through the use of GitHub's web UI. This means you will not need to set up a local development environment of any kind; all you'll need is a browser that can access GitHub and a GitHub account. -Given the above, you should only be using this guide if you plan on making changes that do not impact the functionality of the application. Examples of such cases would be translation fixes, language additions, or quote additions. +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. ### Prerequisites -You must have a browser that can access Github, and possess an account. Once you have those two things, you're ready to move on to making your contribution! +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 I highly recommend giving it a watch. +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 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 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. @@ -39,23 +39,23 @@ This will create a clone of the repository under your own account. Navigate to y There are two methods to making a change in the code. -#### Option 1 - VS Code Web Editor (Recommended) +#### 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. Once done, move on to the [next section to create a pull request](#creating-a-pull-request). -#### Option 2 - Github Web UI +#### 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: -Screenshot showing how to edit files on the Github Web UI. +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, I would also like to point you to [CONTRIBUTING.md](./CONTRIBUTING.md) to view guidelines for theme, language, and quote contributions. +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. @@ -63,7 +63,7 @@ You will find two radio buttons, one prompts you to commit directly to your curr Click `Commit changes` once you are ready to proceed. -Screenshot showing how to commit changes on the Github Web UI. +Screenshot showing how to commit changes on the GitHub Web UI. ### Creating a Pull Request @@ -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 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, don't hesitate 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.