Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AmineDjeghri authored Jan 5, 2025
1 parent 353057b commit 16fe55f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ By participating, you are expected to uphold this code. Please report unacceptab
## 2. Team members:
- Amine Djeghri

## 💡3. Best practices
## 3. Best practices 💡
- Docstring your functions and classes, it is even more important as it is used to generate the documentation with Mkdocs
- If you use an IDE (like pycharm), define src the "source" folder and test the "test" folder so your IDE can help you auto import files
- Use the `make` commands to run your code, it is easier and faster than writing the full command (and check the Makefile for all available commands 😉)
Expand Down

0 comments on commit 16fe55f

Please sign in to comment.