CONTRIBUTING.md

Contributing to Miosomos

This document provides guidelines for contributing to the project.

Setting up the Development Environment

1. Install the uv tool. You can find installation instructions here.
2. Create a virtual environment and install the project dependencies:

   uv sync

3. Set up environment variables by copying the example file:

   cp .env.example .env

4. Install the command line interface (CLI):

   uv tool install ./ --editable

5. You can now use the slice command and the command will update as your code changes.

Coding Standards

• Follow PEP 8 for code style.
• Use ruff for linting.
• Use ty for type checking.

Running Tests and Checks

Before submitting changes, run the following checks:

• Linting: ruff format
• Type checking: ty check

Submitting Changes

1. Fork the repository.
2. Create a branch for your changes: git checkout -b feature/your-feature
3. Commit your changes with a descriptive message.
4. Push your branch to your fork: git push origin feature/your-feature
5. Open a pull request on the main repository.

Reporting Issues

• Use the issue tracker to report bugs or suggest features.
• Provide detailed information about the issue, including steps to reproduce if applicable.