[Docs] Enhancing Contribution Docs#2023
Merged
Merged
Conversation
ly015
reviewed
Mar 7, 2023
ly015
reviewed
Mar 7, 2023
ly015
reviewed
Mar 9, 2023
Comment on lines
+34
to
+39
| Second, check your Git Config. | ||
|
|
||
| ```shell | ||
| # view the Git config | ||
| git config --global --list | ||
| ``` |
Member
There was a problem hiding this comment.
Suggested change
| Second, check your Git Config. | |
| ```shell | |
| # view the Git config | |
| git config --global --list | |
| ``` | |
| Second, check your Git config and ensure that `user.name` and `user.email` are properly configured. | |
| ```shell | |
| # view the Git config | |
| git config --global --list | |
| # configure the user name and email | |
| git config --global user.name "Change your user name here" | |
| git config --global user.email "Change your user email here" |
ly015
reviewed
Mar 9, 2023
| git config --global user.email "Change your useremail here" | ||
| ``` | ||
|
|
||
| Finally, run the command in git bash or terminal to generate the key file. After the generation is successful, a `.ssh` file will appear in the user directory, and `id_rsa.pub` is the public key file. |
Member
There was a problem hiding this comment.
I suggest we remove ssh content and recommend contributors use http, which is easier.
ly015
reviewed
Mar 9, 2023
Comment on lines
+161
to
+167
| git checkout dev-1.x | ||
|
|
||
| git pull upstream dev-1.x | ||
|
|
||
| git checkout username/refactor_contributing_doc | ||
|
|
||
| git rebase dev-1.x |
Member
There was a problem hiding this comment.
By default, the local dev-1.x will track origin/dev-1.x instead of upstream/dev-1.x, so should it be like:
git checkout username/refactor_contributing_doc
git fetch upstream
git rebase upstream/dev-1.x
ly015
reviewed
Mar 9, 2023
Comment on lines
+205
to
+225
| ### Unit Test | ||
|
|
||
| We should also make sure the committed code will not decrease the coverage of unit test, we could run the following command to check the coverage of unit test: | ||
|
|
||
| ```Shell | ||
| python -m coverage run -m pytest tests/ | ||
| python -m coverage html | ||
| # check file in htmlcov/index.html | ||
| ``` | ||
|
|
||
| ### Document rendering | ||
|
|
||
| If the documents are modified/added, we should check the rendering result. We could install the dependencies and run the following command to render the documents and check the results: | ||
|
|
||
| ```Shell | ||
| pip install -r requirements/docs.txt | ||
| cd docs/en/ | ||
| # or docs/zh_cn | ||
| make html | ||
| # check file in ./docs/en/_build/html/index.html | ||
| ``` |
Member
There was a problem hiding this comment.
I think the unit test belongs to 'advanced' part. We can add docs about how do write ut script and how to run it locally in the future.
Online documentation is not what community contributors need to concern about (different from the case of MMYOLO).
ly015
reviewed
Mar 9, 2023
|
|
||
| ```shell | ||
| # clone the forked repository | ||
| git clone git@github.com:{username}/mmpose.git |
Member
There was a problem hiding this comment.
Suggested change
| git clone git@github.com:{username}/mmpose.git | |
| git clone https://github.com/{username}/mmpose.git |
ly015
reviewed
Mar 9, 2023
|
|
||
| # Add official repository as upstream remote | ||
| cd mmpose | ||
| git remote add upstream git@github.com:open-mmlab/mmpose.git |
Member
There was a problem hiding this comment.
Suggested change
| git remote add upstream git@github.com:open-mmlab/mmpose.git | |
| git remote add upstream https://github.com/open-mmlab/mmpose.git |
Please also update other links in EN and CN docs.
ly015
approved these changes
Mar 9, 2023
ly015
reviewed
Mar 9, 2023
ly015
reviewed
Mar 9, 2023
ly015
reviewed
Mar 9, 2023
ly015
reviewed
Mar 9, 2023
ly015
approved these changes
Mar 9, 2023
shuheilocale
pushed a commit
to shuheilocale/mmpose
that referenced
this pull request
May 6, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Modification
BC-breaking (Optional)
Use cases (Optional)
Checklist
Before PR:
After PR: