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

Add documentation #237

Open
Goff-Davis opened this issue Apr 21, 2021 · 0 comments
Open

Add documentation #237

Goff-Davis opened this issue Apr 21, 2021 · 0 comments
Labels
backend todo Issue is not being worked on yet

Comments

@Goff-Davis
Copy link
Collaborator

Goff-Davis commented Apr 21, 2021

Architecture Documentation

An ARCHITECTURE.md file should be created. See here for a somewhat preachy explanation of what that is.

It should cover:

  • the database design (what are the different table, what purpose do they serve, overall design)
  • Each of the endpoints, what input they expect and what output they give, the files associated with them
  • Anything else you think would help give someone an effective mental map of the backend

Readme

Make sure the readme is up to date with all the latest environment variables, commands, and explanations on how to get started developing and deploying.

Commenting

Comments should be added to code that is complex or could be hard to understand. Don't do line by line or real nitty gritty stuff since that can change, but explain the reasoning behind a section, for example.

@Goff-Davis Goff-Davis added backend Non tech todo Issue is not being worked on yet and removed Non tech labels Apr 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend todo Issue is not being worked on yet
Projects
None yet
Development

No branches or pull requests

1 participant