Skip to content

Add CONTRIBUTING.md and quick-start project overview to README #50

@lawie1425

Description

@lawie1425

Problem: The repository lacks a CONTRIBUTING.md and the README provides minimal guidance for new contributors about branching, PRs, and local setup.

Proposed improvement: Add CONTRIBUTING.md outlining branch naming, PR expectations, and issue templates; expand README.md with a concise project purpose and quick-start steps to run or build the project.

Expected benefit: Standardizes contribution workflow and lowers the barrier for first-time contributors.

Files to change: README.md, add CONTRIBUTING.md

Suggested labels: docs, enhancement

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