Skip to content

Clicking contribute should navigate to the project README #6

@MathyouMB

Description

@MathyouMB

As a user, when I click the “Contribute” button, I want to be taken directly to the project’s README so I can quickly understand how to get started with development or contributions.

Image

🧠 Context

Currently, clicking the “Contribute” button does not navigate to the project’s README or any helpful context. This can confuse contributors who are looking for setup instructions or contribution guidelines.

We want to improve this by having the Contribute button link directly to the project’s README.md on GitHub. https://github.com/CarletonComputerScienceSociety/projects-repository


🛠️ Implementation Plan

  1. Identify where the Contribute button is rendered

    src/components/Header/Header.tsx

  2. Update the button behavior

    • Update the onclick to navigate to the readme
      https://github.com/CarletonComputerScienceSociety/project-repository#readme

✅ Acceptance Criteria

  • Clicking the "Contribute" button navigates to the project README on GitHub

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

Status

Ready

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions