Skip to content

Add CONTRIBUTING.md #4

@CohesiumAI

Description

@CohesiumAI

What's needed

The project is missing a CONTRIBUTING.md file to guide new contributors.

Suggested content

  • How to set up the dev environment (node >= 18, clone, run tests)
  • How to run the test suite (npm test)
  • How to add a new platform adapter (create file in generator/adapters/)
  • PR guidelines (branch naming, commit format, test coverage)
  • Code of conduct reference

Why it matters

A clear contribution guide is essential for an open-source project — it lowers the barrier to entry and sets expectations.

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