05 Project Structure - Observatorio-do-Trabalho-de-Pernambuco/documentation GitHub Wiki
Guidance on organizing project folders, creating README files, and managing scripts in production.
- Include a README describing contents and usage
- Maintain consistent formatting (Markdown headings, code blocks)
- Link to scripts, environment instructions, external docs
- Ensure logging, error handling, performance considerations
- PEP8 (if Python)
- Linters/formatters (black, flake8, etc.)
- Function-level docstrings with parameter and return descriptions