Contributing

Setting Up Development Environment

We use poetry as our package and dependency manager.

To create a virtual environment for development, run the following in your shell:

pip install poetry
poetry shell
poetry install --with dev

Simply use exit to deactivate the environment. The next time you call poetry shell the environment will already be setup and ready to go.

Development Workflow

1. Search through existing GitHub Issues to see if what you want to work on has already been added.

   • If not, please create a new issue. This will help to reduce duplicated work.

2. For first-time contributors, visit https://github.com/mirascope/mirascope and "Fork" the repository (see the button in the top right corner).

   • You'll need to set up SSH authentication.

   • Clone the forked project and point it to the main project:

   git clone https://github.com/<your-username>/mirascope.git
   git remote add upstream https://github.com/Mirascope/mirascope.git
   

3. Development.

   • Make sure you are in sync with the main repo:

   git checkout dev
   git pull upstream dev
   

   • Create a git feature branch with a meaningful name where you will add your contributions.

   git checkout -b meaningful-branch-name
   

   • Start coding! commit your changes locally as you work:

   git add mirascope/modified_file.py tests/test_modified_file.py
   git commit -m "feat: specific description of changes contained in commit"
   

   • Format your code!

   poetry run ruff format .
   

   • Lint and test your code! From the base directory, run:

   poetry run ruff check .
   poetry run mypy .
   

4. Test!

   • Add tests. Tests should be mirrored based on structure of the source.

   | - mirascope
   |  | - openai
   |  |  | - calls.py
   | - tests
   |  | - openai
   |  |  | - test_calls.py
   

   • Run tests to make sure nothing broke

   poetry run pytest tests/
   

   • Check coverage report

   poetry run pytest tests/ --cov=./ --cov-report=html
   

5. Contributions are submitted through GitHub Pull Requests

   • When you are ready to submit your contribution for review, push your branch:

   git push origin meaningful-branch-name
   

   • Open the printed URL to open a PR.

   • Fill in a detailed title and description.

   • Check box to allow edits from maintainers

   • Submit your PR for review. You can do this via Contribute in your fork repo.

   • Link the issue you selected or created under "Development"

   • We will review your contribution and add any comments to the PR. Commit any updates you make in response to comments and push them to the branch (they will be automatically included in the PR)

Pull Requests

Please conform to the Conventional Commits specification for all PR titles and commits.

Testing

All changes to the codebase must be properly unit tested. If a change requires updating an existing unit test, make sure to think through if the change is breaking.

We use pytest as our testing framework. If you haven't worked with it before, take a look at their docs.

Furthermore, we have a full coverage requirement, so all incoming code must have 100% coverage. This policy ensures that every line of code is run in our tests. However, while achieving full coverage is essential, it is not sufficient on its own. Coverage metrics ensure code execution but do not guarantee correctness under all conditions. Make sure to stress test beyond coverage to reduce bugs.

We use a Codecov dashboard to monitor and track our coverage.

Formatting and Linting

In an effort to keep the codebase clean and easy to work with, we use ruff for formatting and both ruff and mypy for linting. Before sending any PR for review, make sure to run both ruff and mypy.

If you are using VS Code, then install the extensions in .vscode/extensions.json and the workspace settings should automatically run ruff formatting on save and show ruff and mypy errors.