Skip to content

Module maturity: Add minimum README + setup/run/test status #84

@rishabhhinduja

Description

@rishabhhinduja

Some modules have incomplete or placeholder docs, making them hard to understand or use.

Examples:

Medi_Predict/Readme.md → almost empty
Dsa_Visualizer/Idea.md → idea only, no implementation details
Geospatial Civic Engine for Climate Response/README.md → license TBD, contribution guide incomplete

Problem:

Poor onboarding
Unclear module status
Hard to run/test modules

Solution:
Add a minimum README for every module including:

Overview
Current status (Idea / In Progress / Functional)
Setup & run instructions
Testing status
(Optional) Contribution + license

Acceptance Criteria:

Every module has a meaningful README.md
No placeholder text like “coming soon”
Clear setup/run/test info for each module

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions