-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
code qualityIt refers to improving maintainability, readability, and adherence to coding standards.It refers to improving maintainability, readability, and adherence to coding standards.enhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomers
Description
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
pylintas a development dependency in the project. - Update any necessary documentation or
READMEto inform contributors about the use ofpylint.
2. Configuration:
- Set up a
.pylintrcconfiguration 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
pylintagainst 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
pylintrules, 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
Labels
code qualityIt refers to improving maintainability, readability, and adherence to coding standards.It refers to improving maintainability, readability, and adherence to coding standards.enhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomers