Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

31 lines (22 loc) · 1.1 KB

Contributing

Thank you for your interest in contributing to MOSShell! This document provides guidelines and instructions for contributing.

Before You Start

We welcome contributions! These guidelines exist to save everyone time. Following them means your work is more likely to be accepted.

All pull requests require a corresponding issue. Unless your change is trivial (typo, docs tweak, broken link), create an issue first. Every merged feature becomes ongoing maintenance, so we need to agree that it's worth doing before reviewing code. PRs without a linked issue will be closed.

Development Setup

  1. Make sure you have Python 3.10+ installed.
  2. Install uv.
  3. Fork the repository and clone your fork.
  4. Install development dependencies: make prepare.
  5. Create a new branch and make your changes.
  6. Run formatting, linting, and tests before submitting a PR:
make format
make lint
make test

Checklist

  • Update documentation as needed.
  • Add tests for new functionality.
  • Ensure CI passes.
  • Address review feedback.