-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
docs: missingIndicates that documentation for a feature or component is missing.Indicates that documentation for a feature or component is missing.priority: highImportant tasks that require immediate attention.Important tasks that require immediate attention.special: non-codeTasks that are unrelated to the codebase but support the project (e.g., marketing, outreach).Tasks that are unrelated to the codebase but support the project (e.g., marketing, outreach).status: backlogNot yet started, waiting to be prioritized.Not yet started, waiting to be prioritized.type: documentationChanges or additions to documentation.Changes or additions to documentation.
Description
Description
The project currently lacks a (real) README file to guide contributors and users. A comprehensive README is essential to ensure anyone interested in collaborating or using the application knows how to get started, what the project is about, and how to contribute effectively.
Tasks
- Introduction:
- Briefly explain the purpose of the prototype (as a dating/networking platform for ÉTS).
- Mention the technologies used (e.g., Astro, etc.).
- Getting Started:
- Provide setup instructions for running the project locally (dependencies, installation, and startup).
- Mention any specific requirements (Node.js version, etc.).
- Features:
- Highlight key features of the application.
- List planned features, if applicable.
- Contributing:
- Add guidelines for contributing to the project.
- Include steps for opening issues or pull requests.
- Code of Conduct (optional):
- Link or include a Code of Conduct for contributors (TODO too).
- License:
- Include licensing information, if applicable.
Acceptance Criteria
- README file re-written at the root of the project.
- Provides clear and concise setup instructions.
- Includes guidelines for contributors.
- Explains the project goals and features.
Additional Notes
- Consider adding badges (e.g., build status, license, etc.) for extra clarity.
- A simple graphic or logo for the project can enhance the README's visual appeal.
Metadata
Metadata
Assignees
Labels
docs: missingIndicates that documentation for a feature or component is missing.Indicates that documentation for a feature or component is missing.priority: highImportant tasks that require immediate attention.Important tasks that require immediate attention.special: non-codeTasks that are unrelated to the codebase but support the project (e.g., marketing, outreach).Tasks that are unrelated to the codebase but support the project (e.g., marketing, outreach).status: backlogNot yet started, waiting to be prioritized.Not yet started, waiting to be prioritized.type: documentationChanges or additions to documentation.Changes or additions to documentation.