termdash/doc/design_goals.md

Design goals

This effort is focused on good software design and maintainability. By good design I mean:

1. Write readable, well documented code.
2. Only beautiful, simple APIs, no exposed concurrency, channels, internals, etc.
3. Follow Effective Go.
4. Provide an infrastructure that allows development of individual dashboard components in separation.
5. The infrastructure must enforce consistency in how the dashboard components are implemented.
6. Focus on maintainability, the infrastructure and dashboard components must have good test coverage, the repository must have CI/CD enabled.