-
Notifications
You must be signed in to change notification settings - Fork 20
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 Pre-Commit Hooks for Code Linting and Formatting #219
Comments
@dd-jy I'm interested in this part; would it be okay if I submit a PR? |
Signed-off-by: SaJH <[email protected]>
+You might also consider implementing the pre-commit hook using GitHub Actions to create a workflow. |
@saJaeHyukc 님, 현재 신규 기능 및 Bug fix, Improvement 가 우선이라 줄 맞춤 관련 이슈는 잠시 보류하고자 합니다. 🙏 |
@saJaeHyukc 님, 추가로 PR생성시, pytest -v --flake8를 수행하도록 되어 있습니다. |
해당 부분 github actions에 pre-commit으로 통합하여 검사하면 어떨까 싶습니다. |
Is your feature request related to a problem? Please describe.
I'm always frustrated when inconsistent code styles and formatting issues are committed to the repository. These inconsistencies can make the codebase harder to read and maintain. Additionally, they can lead to avoidable errors that could have been caught by automated linting tools.
Describe the solution you'd like
I propose adding pre-commit hooks to our repository that will automatically run code linting and formatting tools before any commit is made. This will ensure that all code committed adheres to a consistent style and quality standard. Specifically, we can integrate tools like flake8 for Python linting, black for code formatting, isort for sorting imports, and autoflake for removing unused imports and variables.
Describe alternatives you've considered
Additional context
Adding pre-commit hooks will streamline our development process and improve overall code quality. It will also save time during code reviews, as reviewers can focus on logic and functionality rather than style issues. Below are some additional resources and examples of how to set up pre-commit hooks with flake8, black, isort, and autoflake:
The text was updated successfully, but these errors were encountered: