Skip to content

Add READMEΒ #4

@MathyouMB

Description

@MathyouMB

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

  1. Create a new README.md file at the root of the repo

  2. Include the following sections:

πŸ“¦ Setup

npm install
npm run dev

βœ… Testing

npm run test

🎨 Formatting

npm run format

πŸ› οΈ Adding a New Project

  1. Create a folder under content/projects/

  2. 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"
    ---
  3. (Optional) Add a preview image to the same folder and reference it using the previewImageUrl field


βœ… Acceptance Criteria

  • A README.md file exists at the root of the repo
  • It includes setup, testing, and formatting instructions
  • It contains a clear step-by-step guide for adding new projects with a sample frontmatter block

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

Status

Ready

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions