mirror of
https://github.com/monkeytypegame/monkeytype.git
synced 2024-09-20 07:16:17 +08:00
Update some document links (#2919)
* Update some document links * Updated repo link
This commit is contained in:
parent
b3f3c447c1
commit
0dac742efb
2
.github/ISSUE_TEMPLATE/config.yml
vendored
2
.github/ISSUE_TEMPLATE/config.yml
vendored
|
@ -1,5 +1,5 @@
|
|||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Feature Request / Idea
|
||||
url: https://github.com/Miodec/monkeytype/discussions
|
||||
url: https://github.com/monkeytypegame/monkeytype/discussions
|
||||
about: Please do not create issues for feature requests. Instead, use GitHub Discussions.
|
||||
|
|
2
.github/pull_request_template.md
vendored
2
.github/pull_request_template.md
vendored
|
@ -15,6 +15,6 @@ Closes #
|
|||
<!-- the issue(s) your PR resolves if any (delete if that is not the case) -->
|
||||
<!-- please also reference any issues and or PRs related to your pull request -->
|
||||
|
||||
<!-- pro tip: you can mention an issue, PR, or discussion on GitHub by referencing its hash number e.g: [#1234](https://github.com/Miodec/monkeytype/pull/1234) -->
|
||||
<!-- pro tip: you can mention an issue, PR, or discussion on GitHub by referencing its hash number e.g: [#1234](https://github.com/monkeytypegame/monkeytype/pull/1234) -->
|
||||
|
||||
<!-- pro tip: you can press . (dot or period) in the code tab of any GitHub repo to get access to GitHub's VS Code web editor Enjoy! :) -->
|
||||
|
|
|
@ -125,7 +125,7 @@ Before submitting a theme make sure...
|
|||
- your theme has been added to the `_list` file and the `textColor` property is the theme's main color
|
||||
- your theme is clear and readable with both `flip test colors` and `colorful mode` enabled and disabled
|
||||
|
||||
(If you want to contribute themes but don't know how, check [THEMES.md](https://github.com/Miodec/monkeytype/blob/master/THEMES.md))
|
||||
(If you want to contribute themes but don't know how, check [THEMES.md](./THEMES.md))
|
||||
|
||||
#### Language Guidelines
|
||||
|
||||
|
@ -134,7 +134,7 @@ Before submitting a theme make sure...
|
|||
- Be sure to add your language to the `_list` and `_groups` files
|
||||
- Make sure the number of words in the file corresponds to the file name (for example: `languageName.json` is 200 words, `languageName_1k.json` is 1000 words, and so on)
|
||||
|
||||
(If you want to contribute languages but don't know how, check [LANGUAGES.md](https://github.com/Miodec/monkeytype/blob/master/LANGUAGES.md))
|
||||
(If you want to contribute languages but don't know how, check [LANGUAGES.md](./LANGUAGES.md))
|
||||
|
||||
#### Quote Guidelines
|
||||
|
||||
|
@ -145,8 +145,8 @@ Before submitting a theme make sure...
|
|||
- Verify the `id` property is incremented correctly
|
||||
- Please do not add extremely short quotes (less than 60 characters)
|
||||
|
||||
(If you want to contribute quotes but don't know how, check [QUOTES.md](https://github.com/teddinotteddy/monkeytype/blob/8d5ffde578030a07458cec391e862f8f3cd5b4b4/QUOTES.md))
|
||||
(If you want to contribute quotes but don't know how, check [QUOTES.md](./QUOTES.md))
|
||||
|
||||
## 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/Miodec/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.
|
||||
|
|
|
@ -7,7 +7,7 @@
|
|||
|
||||
### 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/Miodec/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.
|
||||
|
||||
<img width="1552" alt="Screenshot showing location of the fork button on GitHub." src="https://user-images.githubusercontent.com/83455454/149194972-23343642-7a1f-4c0c-b5f2-36f4b39a2639.png">
|
||||
|
||||
|
@ -30,7 +30,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. `leftToRight` indicates how the language is written. If it is written left to right then put `true`, otherwise put `false`.
|
||||
`ligatures` A ligature occurs when multiple letters are joined together to form a character [more details](https://en.wikipedia.org/wiki/Ligature_(writing)). 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](<https://en.wikipedia.org/wiki/Ligature_(writing)>). 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.
|
||||
|
||||
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:
|
||||
|
||||
|
@ -76,4 +76,4 @@ Create a pull request:
|
|||
## Language Guidelines
|
||||
|
||||
Make sure your language follows the language guidelines.
|
||||
[Language guidelines](https://github.com/Miodec/monkeytype/blob/master/CONTRIBUTING.md#language-guidelines)
|
||||
[Language guidelines](./CONTRIBUTING.md#language-guidelines)
|
||||
|
|
|
@ -7,7 +7,7 @@
|
|||
|
||||
### 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.
|
||||
First you will have to copy the Monkeytype repository also known as forking. Go to the [Monkeytype Repo](https://github.com/monkeytypegame/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">
|
||||
|
||||
|
@ -39,4 +39,4 @@ Create a pull request:
|
|||
## Quote Guidelines
|
||||
|
||||
Make sure your quote(s) follows the quote guidelines.
|
||||
[Quote guidelines](https://github.com/Miodec/monkeytype/blob/master/CONTRIBUTING.md#quote-guidelines)
|
||||
[Quote guidelines](./CONTRIBUTING.md#quote-guidelines)
|
||||
|
|
10
README.md
10
README.md
|
@ -1,4 +1,4 @@
|
|||
[![](https://github.com/Miodec/monkeytype/blob/master/frontend/static/images/githubbanner2.png?raw=true)](https://monkeytype.com/)
|
||||
[![](https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/images/githubbanner2.png?raw=true)](https://monkeytype.com/)
|
||||
<br />
|
||||
|
||||
<img align="left" alt="TypeScript" width="26px" src="https://iconape.com/wp-content/png_logo_vector/typescript.png" />
|
||||
|
@ -30,15 +30,15 @@ On the [Monkeytype Discord server](https://www.discord.gg/monkeytype), we added
|
|||
|
||||
# Bug report or Feature request
|
||||
|
||||
If you encounter a bug or have a feature request, [send us an email](mailto:jack@monkeytype.com), [create an issue](https://github.com/Miodec/monkeytype/issues), [create a discussion thread](https://github.com/Miodec/monkeytype/discussions), or [join the Discord server](https://www.discord.gg/monkeytype).
|
||||
If you encounter a bug or have a feature request, [send us an email](mailto:jack@monkeytype.com), [create an issue](https://github.com/monkeytypegame/monkeytype/issues), [create a discussion thread](https://github.com/monkeytypegame/monkeytype/discussions), or [join the Discord server](https://www.discord.gg/monkeytype).
|
||||
|
||||
# Want to Contribute?
|
||||
|
||||
Refer to [CONTRIBUTING.md](https://github.com/Miodec/monkeytype/blob/master/CONTRIBUTING.md).
|
||||
Refer to [CONTRIBUTING.md](./CONTRIBUTING.md).
|
||||
|
||||
# Code of Conduct
|
||||
|
||||
Before contributing to this repository, please read the [code of conduct](https://github.com/Miodec/monkeytype/blob/master/CODE_OF_CONDUCT.md).
|
||||
Before contributing to this repository, please read the [code of conduct](.master/CODE_OF_CONDUCT.md).
|
||||
|
||||
# Credits
|
||||
|
||||
|
@ -46,7 +46,7 @@ Before contributing to this repository, please read the [code of conduct](https:
|
|||
|
||||
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/Miodec/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) that have helped with implementing various features, adding themes, fixing bugs, and more.
|
||||
|
||||
# Support
|
||||
|
||||
|
|
|
@ -7,7 +7,7 @@
|
|||
|
||||
### 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/Miodec/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.
|
||||
|
||||
<img width="1552" alt="Screenshot showing location of the fork button on GitHub." src="https://user-images.githubusercontent.com/83455454/149194972-23343642-7a1f-4c0c-b5f2-36f4b39a2639.png">
|
||||
|
||||
|
@ -63,4 +63,4 @@ Add some screenshots of your theme to the pull request. Click "create pull reque
|
|||
## Theme Guidelines
|
||||
|
||||
Make sure your theme follows the theme guidelines.
|
||||
[Theme guidelines](https://github.com/Miodec/monkeytype/blob/master/CONTRIBUTING.md#theme-guidelines)
|
||||
[Theme guidelines](./CONTRIBUTING.md#theme-guidelines)
|
||||
|
|
|
@ -211,7 +211,7 @@
|
|||
</p>
|
||||
<p>
|
||||
<a
|
||||
href="https://github.com/Miodec/monkeytype/graphs/contributors"
|
||||
href="https://github.com/monkeytypegame/monkeytype/graphs/contributors"
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
style="margin-right: 0.5rem"
|
||||
|
|
Loading…
Reference in a new issue