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] Update README.md #119

Merged
merged 3 commits into from
Jul 31, 2023
Merged

[Enhancement] Update README.md #119

merged 3 commits into from
Jul 31, 2023

Conversation

tonysy
Copy link
Collaborator

@tonysy tonysy commented Jul 27, 2023

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.

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:

  • Pre-commit or other linting tools are used to fix the potential lint issues.
  • Bug fixes are fully covered by unit tests, the case that causes the bug should be added in the unit tests.
  • The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  • The documentation has been modified accordingly, like docstring or example tutorials.

After PR:

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

@tonysy tonysy requested a review from gaotongxiao July 27, 2023 12:07
Copy link
Collaborator

@gaotongxiao gaotongxiao left a comment

Choose a reason for hiding this comment

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

Don't forget to update Chinese version as well

@gaotongxiao
Copy link
Collaborator

Thanks for your contribution! The linting test seems not passed.

image

You can install pre-commit hooks to automatically fix this issue:

pip install -U pre-commit
pre-commit install
pre-commit run --all-files
git add --update
git commit

README.md Show resolved Hide resolved
@Leymore Leymore requested a review from Ezra-Yu July 28, 2023 09:52
Copy link
Collaborator

@Ezra-Yu Ezra-Yu left a comment

Choose a reason for hiding this comment

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

LGTM.

@gaotongxiao gaotongxiao merged commit d860b61 into main Jul 31, 2023
2 checks passed
@gaotongxiao gaotongxiao deleted the tonysy-patch-1 branch July 31, 2023 10:26
go-with-me000 pushed a commit to go-with-me000/opencompass that referenced this pull request Oct 9, 2023
* Update README.md

* update README_zh-CN.md

* update get_started

---------

Co-authored-by: Leymore <zfz-960727@163.com>
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.

None yet

4 participants