As a contributor, I want a clear README.md in the root of the repo so I know how to set up the project, run tests, format code, and contribute new projects to the site.
🧠 Context
Right now, the project repository does not include a README. Adding one will make onboarding easier for new contributors and document the expected workflow for development, testing, formatting, and adding student projects to the site.
🛠️ Implementation Plan
-
Create a new README.md file at the root of the repo
-
Include the following sections:
📦 Setup
✅ Testing
🎨 Formatting
🛠️ Adding a New Project
-
Create a folder under content/projects/
-
Inside that folder, create an index.md file with the following frontmatter:
---
id: "another-project"
title: "Another Project"
description: "This is a description of another project that showcases my skills in React Native and AR technology."
author: "Matthew MacRae-Bovell"
tags:
- Example Tag
- React Native
- AR
githubUrl: "https://github.com/sarahchen/campus-nav"
previewImageUrl: "./placeholder.svg"
---
-
(Optional) Add a preview image to the same folder and reference it using the previewImageUrl field
✅ Acceptance Criteria
As a contributor, I want a clear
README.mdin the root of the repo so I know how to set up the project, run tests, format code, and contribute new projects to the site.🧠 Context
Right now, the project repository does not include a README. Adding one will make onboarding easier for new contributors and document the expected workflow for development, testing, formatting, and adding student projects to the site.
🛠️ Implementation Plan
Create a new
README.mdfile at the root of the repoInclude the following sections:
📦 Setup
✅ Testing
npm run test🎨 Formatting
🛠️ Adding a New Project
Create a folder under
content/projects/Inside that folder, create an
index.mdfile with the following frontmatter:(Optional) Add a preview image to the same folder and reference it using the
previewImageUrlfield✅ Acceptance Criteria
README.mdfile exists at the root of the repo