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

Fix #117: Linting standards for software-developer-tool #178

Closed
wants to merge 1 commit into from

Conversation

Ash-2k3
Copy link
Contributor

@Ash-2k3 Ash-2k3 commented May 1, 2024

Fix #117.

This PR introduces the usage of flake8 for this project. I chose Flake8 for this project because our current priority is establishing a strong baseline for code style and catching common errors. Flake8 does this efficiently with minimal overhead. It's also easier for the team to adopt and maintain. If the project grows significantly in complexity, we can always consider integrating a more comprehensive linter like Pylint in the future.

@Ash-2k3
Copy link
Contributor Author

Ash-2k3 commented May 1, 2024

This PR is still WIP:

We need to decide on configurations like, max-length allowed, if we want to ignore some specific errors, etc..

@Ash-2k3
Copy link
Contributor Author

Ash-2k3 commented May 1, 2024

Also, once this PR gets merged, we would want to update the installation.md file to install two more packages which are pre-commit and flake8. And then to run command pre-commit install to install the pre-commit hooks.

@Ash-2k3 Ash-2k3 marked this pull request as ready for review May 1, 2024 19:03
@Ash-2k3
Copy link
Contributor Author

Ash-2k3 commented May 3, 2024

I am planning to close this PR for now, as I have thought of a better approach to add linters and also we need to discuss about the coding standards for linting (This can be done in the upcoming meet on 8th May). Thanks!

/cc @pleia2

@Ash-2k3 Ash-2k3 closed this May 3, 2024
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.

Linting standards for software-developer-tool
1 participant