Skip to content

Adding CONTRIBUTION.md #655

Description

@rororowyourboat

Context

MSML currently lacks a clear contribution guide. New contributors have to infer:

  • How to set up the environment
  • How to structure changes
  • How to run tests or validate work

This increases friction and leads to inconsistent contributions.


Goals

  • Standardize the contribution workflow
  • Reduce onboarding time for new contributors
  • Make expectations explicit

Scope

  • Add CONTRIBUTING.md covering:

    • Environment setup
    • Repo structure overview
    • Coding and documentation expectations
    • How to submit PRs and run checks locally
  • Link to dev container and package management docs where relevant


Deliverables

  • CONTRIBUTING.md at repo root
  • References from README and docs

Non-Goals

  • Legal or governance policies
  • Extensive style guides

Activity

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

Metadata

Metadata

Labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions