Skip to content

Docs: Standardize README files across repositories #232

@areycruzer

Description

@areycruzer

Description

Currently, the MoFA ecosystem has many repositories (27+), but most lack a standardized, professional README format. Many repos are missing descriptions, badges, screenshots, and unified Quick Starts, which creates a fragmented onboarding experience for new contributors and GSoC applicants.

This issue proposes to introduce a standardized README template and an automated script to unify the documentation style across all MoFA repositories.

Proposed Changes

  • Create a unified .github/README_TEMPLATE.md containing best practices (badges for license/stars/Discord/docs, TOC, quick start, architecture, features, contributing).
  • Create a .github/scripts/standardize_readme.py script that can be run to apply the template consistently.
  • Apply the standardized header and structure to the main mofa and mofa-studio repositories initially as a proof of concept.

This will serve as a quick win to greatly improve developer experience before GSoC 2026 fully ramps up.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions