Skip to content

Docs: add a Contributing section to the README #33

@thetechjon

Description

@thetechjon

Context

The README jumps from the user-facing feature list to dev setup. Drive-by contributors who want to help do not know that CONTRIBUTING.md exists or where to find good entry points. A small, friendly Contributing section between the feature list and the dev setup would convert curiosity to PRs.

Where to look

  • README.md — the README is currently structured as user-first (CTA + features) then a --- separator then dev setup. The new section goes right above the ---.
  • CONTRIBUTING.md — already exists; the new README section links to it.

Acceptance criteria

Complexity

Tiny. Probably the best first PR for someone who wants to verify the contribution workflow before tackling code.

For first-time contributors

Fork the repo, edit README.md in your fork, push to a branch, open a PR against dev. That's it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions