Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how the code works #833

Open
pmcelhaney opened this issue Apr 5, 2024 · 0 comments
Open

Document how the code works #833

pmcelhaney opened this issue Apr 5, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@pmcelhaney
Copy link
Owner

This is a reminder to myself. Each directory should have a README.md that explains how the code works at a high level, maybe a one line description of each file, and some UML diagrams.

Also there should be a document somewhere that lists design principles, e.g.:

  • the principle of least surprise
  • "Easy things should be easy, hard things should be possible" - Larry Wall
  • speed is important
  • as much as possible, make restarting the server unnecessary
  • degrade gracefully without breaking
@pmcelhaney pmcelhaney added the documentation Improvements or additions to documentation label Apr 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant