Architectural Decision Records#
Architectural decisions are made throughout a project’s lifetime. As a way of keeping track of these decisions, we record these decisions in Architecture Decision Records (ADRs) listed below.
- 1. Record architecture decisions
- 2. Make a skeleton repository
- 3. Standard documentation structure
- 4. Use a source directory
- 5. Use pyproject.toml
- 6. Use setuptools_scm
- 7. Installing developer environment
- 8. Use tox and pre-commit
- 9. Sphinx theme
- 10. Include vscode settings
- 11. Pinning requirements
- 12. Use containers
- 13. Switch to copier
- 14. Split up CI YAML
- 15. Use ruff
- 16. Convert to mkdocs
- 17. Use pyright
- 18. Forbid Private Member Access in Production Code
For more information on ADRs see this blog by Michael Nygard.