|
1 | 1 | # 07 - Code quality
|
2 | 2 |
|
3 |
| -In Lesson [04 - Professional Project](../04-professional-project) we created a repo and website for an old project developed during the course. Now we are going to improve its quality by fixing the issues each group found using a linter tool. |
| 3 | +In Lesson [04 - Professional Project](../04-professional-project) we created a repo and website for an old project developed during the course. Now we are going to improve its quality by fixing the issues from each group by using a **linter** tool. |
| 4 | + |
| 5 | +**Linters** analyze your code for potential errors, enforce coding standards, improve readability and security. They are useful tools to ensure high-quality of coding. Some popular Python linter tools: |
| 6 | + |
| 7 | +1. **Flake8:** |
| 8 | +Combines tools like PyFlakes, pycodestyle, and McCabe. |
| 9 | +Detects syntax errors, style guide violations (PEP 8), and cyclomatic complexity. |
| 10 | +Lightweight and easy to integrate into CI/CD pipelines. |
| 11 | + |
| 12 | + |
| 13 | +2. **Pylint:** |
| 14 | +Comprehensive linter that checks for errors, enforces coding standards, and suggests code refactoring. |
| 15 | +Provides a detailed score for your code quality. |
| 16 | +Highly configurable, but may require some setup to avoid excessive warnings. |
4 | 17 |
|
5 | 18 | !!! warning
|
6 |
| - We won't work on our own projects this time! Select a project from [ongoing projects page](../../projects/2024/2/index.md) and comment on the issue you'd like to do or create a new issue that you'd like to work on. Every project must have at least one issue with external participation. |
| 19 | + We won't work on our **own** projects this time! Select a project from [ongoing projects page](../../projects/2025/2/index.md) and comment on the issue you'd like to do or create a new issue that you'd like to work on. Every project must have at least one issue with external participation. |
7 | 20 |
|
8 | 21 |
|
9 | 22 | ## Deliverable
|
10 | 23 |
|
11 | 24 | { style="height:150px" }
|
12 | 25 |
|
13 | 26 | - create a Pull/Merge request addressing a code quality issue found in another team's project.
|
14 |
| -- work with other team to get a Pull/Merge request accepted in your repository |
| 27 | +- work with other team to get a Pull/Merge request accepted in your repository. |
15 | 28 |
|
16 |
| -**Learning objective**: modify a project you are not familiar with and improve its code quality |
| 29 | +**Learning objective**: modify a project you are not familiar with and improve its code quality. |
17 | 30 |
|
18 | 31 | > "skill_id": 11, "metadata": {"url": "pull request url", "group": ["student2"]}
|
19 | 32 |
|
|
0 commit comments