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.

Sign up for GitHub

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

Jump to bottom

Document codebase #18

Closed
4 tasks
elliotBraem opened this issue Aug 1, 2024 · 1 comment
Closed
4 tasks

Document codebase #18

elliotBraem opened this issue Aug 1, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation
Milestone
v1

Comments

@elliotBraem
Copy link
Contributor

elliotBraem commented Aug 1, 2024 •
edited
Loading

According to SOW, we need documented codebase for handoff:

Documented Codebase: Have detailed documentation on the codebase and ensure it is easily understandable for future maintainers.

Acceptance Criteria

  • Add README, be sure to document any setup + steps for running, document scripts (let's start with https://github.com/othneildrew/Best-README-Template)
  • .env.example (if necessary)
  • outline any standards or guidelines the project has followed
  • document any non-self-explanatory functions, components, types, and stores
@elliotBraem elliotBraem added the documentation Improvements or additions to documentation label Aug 1, 2024
@elliotBraem elliotBraem added this to the v1 milestone Aug 1, 2024
@elliotBraem
Copy link
Contributor Author

elliotBraem commented Aug 6, 2024 •
edited
Loading

Resolved in #22

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
v1
Development

No branches or pull requests
1 participant
@elliotBraem