Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (34 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

50 lines (34 loc) · 1.14 KB
Raw

Contributing to OrbitStream Backend

Thank you for your interest in contributing to OrbitStream! This guide will help you get started.

Code of Conduct

This project adheres to the Contributor Covenant v2.1. By participating, you are expected to uphold this code.

Architecture

For a full understanding of the OrbitStream system, see the architecture documentation.

Getting Started

Prerequisites

  • Node.js >= 20
  • PostgreSQL

Setup

npm install
cp .env.example .env
npm run dev

Checks

npm run lint
npm run build
npm test

Development Workflow

  1. Fork this repository
  2. Create a feature branch: git checkout -b feat/your-feature
  3. Make your changes
  4. Ensure all checks pass (see above)
  5. Commit using conventional commits: feat:, fix:, docs:, test:
  6. Open a Pull Request against main

Pull Request Guidelines

  • PRs must be linked to an issue
  • All CI checks must pass
  • Include a description of what changed and why
  • Add tests for new functionality