Skip to content

Commit 49b281f

Browse files
committed
Updates on class 7
1 parent bbd7f30 commit 49b281f

File tree

3 files changed

+23
-4
lines changed

3 files changed

+23
-4
lines changed
55 KB
Loading

docs/lessons/07-code-quality/index.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,32 @@
11
# 07 - Code quality
22

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+
![](./Flake8.png)
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.
417

518
!!! 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.
720

821

922
## Deliverable
1023

1124
![](icon.svg){ style="height:150px" }
1225

1326
- 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.
1528

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.
1730

1831
> "skill_id": 11, "metadata": {"url": "pull request url", "group": ["student2"]}
1932

docs/projects/2025/2/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# 2025/2
2+
3+
* [https://balbismo-lang.ariellev.dev.br](https://balbismo-lang.ariellev.dev.br)
4+
* [https://github.com/JoaoLucasMBC/pycube-projection](https://github.com/JoaoLucasMBC/pycube-projection)
5+
* [https://joaopgs4.github.io/opensource-project/](https://joaopgs4.github.io/opensource-project/)
6+
* [https://github.com/cairibep/Packages_Tracker](https://github.com/cairibep/Packages_Tracker)

0 commit comments

Comments
 (0)