Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Polish readme #1320

Merged
merged 8 commits into from
Oct 13, 2021
Merged

Polish readme #1320

merged 8 commits into from
Oct 13, 2021

Conversation

zhouzaida
Copy link
Collaborator

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

Motivation

Polish README

Modification

Please briefly describe what modification is made in this PR.

BC-breaking (Optional)

Does the modification introduce changes that break the backward-compatibility of the downstream repositories?
If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.

Use cases (Optional)

If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.

Checklist

Before PR:

  • I have read and followed the workflow indicated in the CONTRIBUTING.md to create this PR.
  • Pre-commit or linting tools indicated in CONTRIBUTING.md are used to fix the potential lint issues.
  • Bug fixes are covered by unit tests, the case that causes the bug should be added in the unit tests.
  • New functionalities are covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  • The documentation has been modified accordingly, including docstring or example tutorials.

After PR:

  • If the modification has potential influence on downstream or other related projects, this PR should be tested with some of those projects, like MMDet or MMCls.
  • CLA has been signed and all committers have signed the CLA in this PR.

@hellock
Copy link
Member

hellock commented Sep 7, 2021

Another option: just rename the path from 1.8.0 to 1.8.

README_zh-CN.md Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Sep 7, 2021

Codecov Report

Merging #1320 (0dfb91e) into master (6434d0d) will not change coverage.
The diff coverage is n/a.

❗ Current head 0dfb91e differs from pull request most recent head 44b3fb8. Consider uploading reports for the commit 44b3fb8 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1320   +/-   ##
=======================================
  Coverage   69.14%   69.14%           
=======================================
  Files         162      162           
  Lines       10746    10746           
  Branches     1978     1978           
=======================================
  Hits         7430     7430           
  Misses       2927     2927           
  Partials      389      389           
Flag Coverage Δ
unittests 69.14% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6434d0d...44b3fb8. Read the comment docs.

@zhouzaida zhouzaida mentioned this pull request Sep 24, 2021
29 tasks
@ZwwWayne ZwwWayne merged commit 48d5b09 into open-mmlab:master Oct 13, 2021
@zhouzaida zhouzaida deleted the polish-readme branch November 4, 2021 07:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants