-
Notifications
You must be signed in to change notification settings - Fork 1
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Rewrite the README including the following sections:
- Project Overview
- Features
- Project Structure
- Getting Started
- Running the project
- Environment variables
- Building for prod (howto)
- Testing (how to run unit tests that, as of right now, dont exist)
- Contributing how to
- License
- Contact / Maintainer info
Additional documentation files to accompany README
DEPLOYMENT.md– Detailed deployment instructions (environment setup, CI/CD, hosting).CONTRIBUTING.md** – Guidelines for contributors (branch naming, commit style, code review).- And any others that may be warranted.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation