"docs/vscode:/vscode.git/clone" did not exist on "fab4f3d6e4bf055555e8fc492b1e6a2307cfa9c8"
Unverified Commit f3a624e3 authored by Range King's avatar Range King Committed by GitHub
Browse files

[Doc] fix typos in EN contributing.md (#2462)

parent 49d89175
...@@ -4,18 +4,18 @@ Welcome to the MMCV community, we are committed to building a cutting-edge compu ...@@ -4,18 +4,18 @@ Welcome to the MMCV community, we are committed to building a cutting-edge compu
**Fix bug** **Fix bug**
You can directly post a Pull Request to fix typo in code or documents You can directly post a Pull Request to fix typos in code or documents
The steps to fix the bug of code implementation are as follows. The steps to fix the bug of code implementation are as follows.
1. If the modification involve significant changes, you should create an issue first and describe the error information and how to trigger the bug. Other developers will discuss with you and propose an proper solution. 1. If the modification involves significant changes, you should create an issue first and describe the error information and how to trigger the bug. Other developers will discuss it with you and propose a proper solution.
2. Posting a pull request after fixing the bug and adding corresponding unit test. 2. Posting a pull request after fixing the bug and adding corresponding unit test.
**New Feature or Enhancement** **New Feature or Enhancement**
1. If the modification involve significant changes, you should create an issue to discuss with our developers to propose an proper design. 1. If the modification involves significant changes, you should create an issue to discuss with our developers to propose a proper design.
2. Post a Pull Request after implementing the new feature or enhancement and add corresponding unit test. 2. Post a Pull Request after implementing the new feature or enhancement and add the corresponding unit test.
**Document** **Document**
...@@ -23,7 +23,7 @@ You can directly post a pull request to fix documents. If you want to add a docu ...@@ -23,7 +23,7 @@ You can directly post a pull request to fix documents. If you want to add a docu
### Pull Request Workflow ### Pull Request Workflow
If you're not familiar with Pull Request, don't worry! The following guidance will tell you how to create a Pull Request step by step. If you want to dive into the develop mode of Pull Request, you can refer to the [official documents](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) If you're not familiar with Pull Request, don't worry! The following guidance will tell you how to create a Pull Request step by step. If you want to dive into the development mode of Pull Request, you can refer to the [official documents](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
#### 1. Fork and clone #### 1. Fork and clone
...@@ -37,13 +37,13 @@ Then, you can clone the repositories to local: ...@@ -37,13 +37,13 @@ Then, you can clone the repositories to local:
git clone git@github.com:{username}/mmcv.git git clone git@github.com:{username}/mmcv.git
``` ```
After that, you should ddd official repository as the upstream repository After that, you should add the official repository as the upstream repository.
```bash ```bash
git remote add upstream git@github.com:open-mmlab/mmcv git remote add upstream git@github.com:open-mmlab/mmcv
``` ```
Check whether remote repository has been added successfully by `git remote -v` Check whether the remote repository has been added successfully by `git remote -v`
```bash ```bash
origin git@github.com:{username}/mmcv.git (fetch) origin git@github.com:{username}/mmcv.git (fetch)
...@@ -88,7 +88,7 @@ If the code does not conform to the code style specification, pre-commit will ra ...@@ -88,7 +88,7 @@ If the code does not conform to the code style specification, pre-commit will ra
<img src="https://user-images.githubusercontent.com/57566630/202369176-67642454-0025-4023-a095-263529107aa3.png" width="1200"> <img src="https://user-images.githubusercontent.com/57566630/202369176-67642454-0025-4023-a095-263529107aa3.png" width="1200">
If we want to commit our code bypassing the pre-commit hook, we can use the `--no-verify` option(**only for temporarily commit**. If we want to commit our code bypassing the pre-commit hook, we can use the `--no-verify` option(**only for temporary committing**.
```shell ```shell
git commit -m "xxx" --no-verify git commit -m "xxx" --no-verify
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment