Skip to content

Improve README to reflect project maturity and onboard contributors #16

@jpmewenemesse

Description

@jpmewenemesse

The current README is minimal. It does not reflect the project's purpose, tech stack, or how to contribute, wich matters as this is the public-facing of OKDP.

Missing stuffs

  • Clear description of what this repo is
  • Live site link (https://okdp.io)
  • Badges (licence....)
  • Tech stack overview
  • Project overview
  • Contributors guide link, Licence section
  • Site screenshot

Acceptance criteria

  • README clearly explain what the repo is, how to run it locally, how to build it, and how to contribute

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions