03 Code Practices - Observatorio-do-Trabalho-de-Pernambuco/documentation GitHub Wiki
Guidelines on how we write, organize, and document our code.
Every Jupyter Notebook commited to the repository should follow these naming conventions:
- Format: YYYY-MM-DD_initials_Purpose.ipynb (e.g., 2025-03-01_gsg_Polars_PoC.ipynb)
- Date represents creation date
- Initials should be lowercase and consistent for each team member
- Purpose should be concise but descriptive
- Introduction, Examples, Conclusion
- Logical headers, clear code blocks
- Comments for complex logic
- Group scripts by function or domain
- Keep them short and focused
- Use standard logging libraries
- Graceful error handling with try/except
- NumPy or Google style (choose one consistently)
- Minimum fields: description, parameters, returns
- Summarize purpose, highlight key functions or classes