Skip to content

docs: Create CONTRIBUTING.md with setup guide #39

Description

@AngusHsu

Description

Create CONTRIBUTING.md with development setup instructions.

Parent Epic

#10 - Add CONTRIBUTING.md guide

Sections to Include

Getting Started

  • Prerequisites (Node.js version, npm/yarn)
  • Clone and install instructions
  • Running tests locally
  • Building the project

Development Workflow

  • Branch naming conventions
  • Commit message format
  • PR process
  • Code review expectations

Project Structure

  • Directory layout explanation
  • Key files overview
  • How validators are organized

Template

```markdown

Contributing to idnumbers

Thank you for your interest in contributing!

Getting Started

Prerequisites

  • Node.js 16 or higher
  • npm or yarn

Setup

\`\`\`bash
git clone https://github.com/identique/idnumbers-npm.git
cd idnumbers-npm
npm install
npm test
\`\`\`

Development Workflow

...
```

Acceptance Criteria

  • CONTRIBUTING.md exists in root
  • Setup instructions work
  • Workflow is documented

Labels

documentation, contributing, good-first-issue

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions