Skip to content

Commit

Permalink
docs: revise grammatical errors and typos of MD (#674)
Browse files Browse the repository at this point in the history
* docs: revise grammatical errors and typos of MD

* docs: revise issue-template link
  • Loading branch information
andyhuang18 authored May 20, 2023
1 parent 2220a5b commit 4210cf4
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Before you submit an issue, consider the following guidelines:
- Please search for related issues. Make sure you are not going to open a duplicate issue.
- Please specify what kind of issue it is and explain it in the title or content, e.g. `feature`, `bug`, `documentation`, `discussion`, `help wanted`... The issue will be tagged automatically by the robot of the project(Menbotics). See [supported issue labels][issue-label].

To make the issue details as standard as possible, we setup an [Issue Template][issue-template] for issue reporters. Please be sure to follow the instructions to fill fields in template.
To make the issue details as standard as possible, we set up several [issue templates][issue-template] for issue reporters. Please be sure to follow the instructions to fill fields in template.

There are a lot of cases when you could open an issue:

Expand Down Expand Up @@ -179,5 +179,5 @@ Please sign our [Contributor License Agreement (CLA)][cla] before sending pull r
[repo]: https://github.com/hypertrons/hypertrons-crx
[angular-commit-message-format]: https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines
[pr-template]: ./.github/pull_request_template.md
[issue-template]: ./.github/issue_template.md
[issue-template]: https://github.com/hypertrons/hypertrons-crx/tree/master/.github/ISSUE_TEMPLATE
[cla]: https://cla-assistant.io/hypertrons/hypertrons-crx
16 changes: 8 additions & 8 deletions INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ We welcome users to install and try our Hypertrons Chrome Extension. If you have

## Install from released package

The latest release can be found on this page https://github.com/hypertrons/hypertrons-crx/releases , where `hypertrons.crx` and `hypertrons.zip` are available under `Assets`. Currently, the extension can be installed to multiple browsers that use the chromium kernel. Some common ones are listed as follow:
The latest release can be found on this page https://github.com/hypertrons/hypertrons-crx/releases , where `hypertrons.crx` and `hypertrons.zip` are available under `Assets`. Currently, the extension can be installed to multiple browsers that use the chromium kernel. Some common ones are listed as follows:

- [Chrome](#chrome)

Expand All @@ -93,7 +93,7 @@ The latest release can be found on this page https://github.com/hypertrons/hyper

2. Open Chrome browser and enter [chrome://extensions](chrome://extensions) in the address bar directing to the extension management page.

3. Turn on the **[Developer Mode]** button on the top right corner of this page, then refresh.
3. Turn on the **[Developer Mode]** button in the top right corner of this page, then refresh.

4. Click **[Load Unpacked]** button on the top left, and select the folder where the unzipped files are stored( `hypertrons/`).

Expand All @@ -105,7 +105,7 @@ The latest release can be found on this page https://github.com/hypertrons/hyper

2. Open Edge and enter [edge://extensions/](edge://extensions/) in the address bar directing to the extension management page.

3. Turn on the **[Developer Mode]** button on the bottom left corner of this page, then refresh.
3. Turn on the **[Developer Mode]** button in the bottom left corner of this page, then refresh.

4. Click **[Load Unpacked]** button on the top right, and select the folder (`/build`) under the folder ( `hypertrons/`) unzipped in step 1.

Expand All @@ -117,7 +117,7 @@ The latest release can be found on this page https://github.com/hypertrons/hyper

2. Open the browser and enter [se://extensions/](se://extensions/) in the address bar directing to the extension management page.

3. Turn on the **[Developer Mode]** button on the top right corner of, and then refresh.
3. Turn on the **[Developer Mode]** button in the top right corner of, and then refresh.

4. Drag the downloaded file `hypertrons.crx` into this page.

Expand All @@ -131,7 +131,7 @@ The latest release can be found on this page https://github.com/hypertrons/hyper

2. Open the browser and enter [chrome://myextensions/extensions](chrome://myextensions/extensions) in the address bar directing to the extension management page.

3. Turn on the **[Developer Mode]** button on the top right corner of, and then refresh.
3. Turn on the **[Developer Mode]** button in the top right corner of, and then refresh.

4. Drag the downloaded file `hypertrons.crx` into this page.

Expand All @@ -141,9 +141,9 @@ The latest release can be found on this page https://github.com/hypertrons/hyper

# Additional Configuration

### Adding Github Token
### Adding GitHub Token

Hypertrons requires a github token for getting the avatar and username from Github repositories and getting the hypertrons.json.
Hypertrons requires a GitHub token for getting the avatar and username from GitHub repositories and getting the hypertrons.json.

1. Click on the hypertrons icon to open the menu and select set Token

Expand All @@ -153,7 +153,7 @@ Hypertrons requires a github token for getting the avatar and username from Gith

<img src="assets/en/op.png">

3. You'll need a github token with "public_repo" scope. <a href="https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token">How to generate token?</a>
3. You'll need a GitHub token with "public_repo" scope. <a href="https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token">How to generate token?</a>

<img src="assets/en/mo.png">

Expand Down
2 changes: 1 addition & 1 deletion INSTALLATION.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,6 @@ Hypertrons 需要一个 GitHub token 来从 GitHub 仓库中获取用户信息
3. 粘贴您的 token 后,点击“确定”,您的 token 将会被应用。
<img src="assets/zh-CN/token-3.png">

以上是 Hypertrons-crx 的安装及使用说明,若您在安装和使用过程中有任何问题和建议,可访问项目的 issue 列表 (https://github.com/hypertrons/hypertrons-crx/issues) 或创建 isuue 与我们进行讨论。
以上是 Hypertrons-crx 的安装及使用说明,若您在安装和使用过程中有任何问题和建议,可访问项目的 issue 列表 (https://github.com/hypertrons/hypertrons-crx/issues) 或创建 issue 与我们进行讨论。

感谢您的支持!
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ You can find these dashboards in:
</table>


### Project Releated
### Project Related

<table>
<thead>
Expand Down Expand Up @@ -105,7 +105,7 @@ You can find these dashboards in:
- **Repo Details**: Trends of Activity, OpenRank, Participants, Fork Events, Star Events, Open Issue Events, Issue Comment Events, Open PR Events, PR Merge Events, Review Comment Events, Merged Addition & Deletion Code Lines.


### Developer Releated
### Developer Related

<table>
<thead>
Expand Down

0 comments on commit 4210cf4

Please sign in to comment.