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

[Enhancement] Refactor main page readme. #1609

Merged
merged 43 commits into from
Feb 21, 2023

Conversation

liuwenran
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

Please describe the motivation of this PR and the goal you want to achieve through this PR.

Modification

Please briefly describe what modification is made in this PR.

Who can help? @ them here!

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.
  • CLA has been signed and all committers have signed the CLA in this PR.

README.md Outdated Show resolved Hide resolved
@zengyh1900
Copy link
Collaborator

zengyh1900 commented Jan 18, 2023

  • we need a new teaser.
  • mention migration & changelog in what's new.
  • update major feature.
  • wrong name of colorization model.
  • mention projects in contributing.
  • remove demo.
  • polish acknowledgment.

README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@zengyh1900 zengyh1900 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work. We need a Chinese version (can be implemented in another PR)

@zengyh1900 zengyh1900 merged commit 9751354 into open-mmlab:dev-1.x Feb 21, 2023
@liuwenran liuwenran deleted the refact-readme branch February 21, 2023 08:28
@Z-Fran Z-Fran mentioned this pull request Mar 2, 2023
7 tasks
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.

3 participants