Skip to content

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

@renan-siqueira

Description

@renan-siqueira

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    code qualityIt refers to improving maintainability, readability, and adherence to coding standards.enhancementNew feature or requestgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions