Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (26 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

41 lines (26 loc) · 1.28 KB
Raw

Contributing to OrbitStream Docs

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.

For detailed contribution guidelines across all OrbitStream repos, see the cross-repo contributing guide.

Getting Started

Prerequisites

  • Any markdown editor

Checks

  • Ensure all links resolve
  • Ensure markdown renders correctly
  • Cross-reference with actual code in other repos

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
  • Keep spec.md and openapi.yaml in sync with actual contract/API