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

Install pylint in the project and adapt the code to pylint rules #30

Open
renan-siqueira opened this issue Oct 16, 2023 · 0 comments
Open
Labels
code quality It refers to improving maintainability, readability, and adherence to coding standards. enhancement New feature or request good first issue Good for newcomers

Comments

@renan-siqueira
Copy link
Owner

Objective:

To enhance the code quality and maintainability of our project, we intend to integrate pylint as a linting tool and ensure that our code adheres to its guidelines and standards.

Tasks:

1. Installation:

  • Install pylint as a development dependency in the project.
  • Update any necessary documentation or README to inform contributors about the use of pylint.

2. Configuration:

  • Set up a .pylintrc configuration file if there are specific rules we want to enable/disable or modify based on our project's requirements.
  • Ensure that default pylint rules align with our coding standards and practices.

3. Code Adaptation:

  • Run pylint against the current codebase to identify areas of non-compliance.
  • Address the warnings and errors reported by pylint.
  • It's advisable to handle refactoring in chunks, possibly through multiple pull requests, to make reviewing easier.

4. Continuous Integration:

Integrate pylint checks into our CI/CD pipeline if applicable. This ensures that future code submissions are checked against pylint standards before merging.

Notes:

  • While adapting to pylint rules, ensure that code functionality isn't altered in the process.
  • Consider creating separate issues or pull requests for large modules or files, to keep the review process focused and manageable
@renan-siqueira renan-siqueira added enhancement New feature or request good first issue Good for newcomers labels Oct 16, 2023
@renan-siqueira renan-siqueira self-assigned this Oct 16, 2023
@renan-siqueira renan-siqueira added the code quality It refers to improving maintainability, readability, and adherence to coding standards. label Oct 16, 2023
@renan-siqueira renan-siqueira removed their assignment Oct 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code quality It refers to improving maintainability, readability, and adherence to coding standards. enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant