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

Add code style and error check. #3

Merged
merged 4 commits into from
Jan 5, 2024
Merged

Add code style and error check. #3

merged 4 commits into from
Jan 5, 2024

Conversation

zzhlogin
Copy link
Contributor

@zzhlogin zzhlogin commented Jan 4, 2024

This PR add the code syntax and error check for the whole repo by following the same principle of opentelemetry-python-contrib and use the following tools:

codespell: Find and fix common spelling mistakes.
flake8 and black: Code style check and code formatting.
Isort: Adjust the import statements.
pylint: Configures pylint's style check rules, ignores specific warnings and statements, defines naming conventions, format logging style and spelling, etc,.

@zzhlogin zzhlogin requested a review from a team January 4, 2024 18:00
Copy link
Contributor

@thpierce thpierce left a comment

Choose a reason for hiding this comment

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

For each of the tools used here, I'd like to see them fail, to prove they work. So I want to see:

  • codespell identify a typo
  • flake8 find a style violation
  • isort clean up an import
  • pylint find a style violation

Any others I missed.

.codespellrc Show resolved Hide resolved
.flake8 Outdated Show resolved Hide resolved
.github/workflows/test.yml Outdated Show resolved Hide resolved
.github/workflows/test.yml Show resolved Hide resolved
.isort.cfg Show resolved Hide resolved
tox.ini Show resolved Hide resolved
scripts/update_sha.py Outdated Show resolved Hide resolved
scripts/update_sha.py Outdated Show resolved Hide resolved
scripts/check_for_valid_readme.py Show resolved Hide resolved
scripts/eachdist.py Show resolved Hide resolved
@zzhlogin
Copy link
Contributor Author

zzhlogin commented Jan 5, 2024

For each of the tools used here, I'd like to see them fail, to prove they work. So I want to see:

  • codespell identify a typo
  • flake8 find a style violation
  • isort clean up an import
  • pylint find a style violation

Any others I missed.

I tests these functionality in my forked repo, please find each of them using the link below:

@zzhlogin zzhlogin merged commit 9319463 into main Jan 5, 2024
4 checks passed
@zzhlogin zzhlogin deleted the add_onwership branch January 5, 2024 18:50
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.

2 participants