Skip to content

docs: add Getting Started section and contribution table (closes #59) - #67

Open
zqleslie wants to merge 1 commit into
Anamandla:mainfrom
zqleslie:feat/readme-getting-started-a14
Open

docs: add Getting Started section and contribution table (closes #59)#67
zqleslie wants to merge 1 commit into
Anamandla:mainfrom
zqleslie:feat/readme-getting-started-a14

Conversation

@zqleslie

@zqleslie zqleslie commented Jun 8, 2026

Copy link
Copy Markdown

Summary

Addresses issue #59 for Assignment A14.

Changes

Added a comprehensive "Getting Started" section and "Contribution Roadmap" table to README.md:

Getting Started

  • Prerequisites: Python 3.10+, Git, pip
  • Setup instructions: clone, install, run tests, start API (4-step guide with code blocks)
  • Project Structure table: directory → description mapping

Contribution Roadmap

  • Feature table with label, difficulty, and linked issue columns
  • Links to CONTRIBUTING.md and ROADMAP.md

Header

  • CI status badge: [![CI](https://github.com/Anamandla/SwiftPay/actions/workflows/ci.yml/badge.svg)]

Acceptance Criteria

  • "Getting Started" section: prerequisites, clone, run tests, start API
  • "Features for Contribution" table: feature name, label, difficulty, linked issue
  • CI status badge added to README header
  • Links to CONTRIBUTING.md and ROADMAP.md prominent in README

Closes #59

@mayank-dev-15 mayank-dev-15 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good docs - Getting Started section and contribution table improve onboarding. LGTM.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[A14] Update README — Getting Started section and contribution table

2 participants