Skip to content

Navigation Menu

Sign in
Sign up

Add a contributor quickstart path to the README #3

Open
Labels
documentationImprovements or additions to documentation good first issueGood for newcomers help wantedExtra attention is needed

Description

Goal

Make it easier for a new contributor to understand where to start in Permea Core.

Suggested scope

  • Add a short Contributor quickstart section to README.md or improve the existing contributor pointer.
  • Link to the most relevant files for first-time contributors: CONTRIBUTING.md, docs/OSS_OPERATING_DOCS_MAP.md, and docs/ROADMAP.md.
  • Keep the section concise.

Acceptance criteria

  • A newcomer can identify 2-3 good first places to read.
  • The links point to existing files.
  • The change does not alter project scope or governance policy.

Contributor note

This is a documentation-only issue intended for a first PR.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation good first issueGood for newcomers help wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      AltStyle によって変換されたページ (->オリジナル) /