Skip to main content

​
Welcome Contributors!

We appreciate your interest in contributing to Mirobody Health. This guide will help you get started.

​
Ways to Contribute

Add Providers

Integrate new health device providers

Fix Bugs

Report and fix issues

Improve Docs

Enhance documentation

Add Features

Propose and implement new features

​
Getting Started

1

Fork the repository

Create your own fork of the Mirobody Health repository
2

Set up development environment

Follow the Development Setup guide
3

Create a branch

git checkout -b feature/your-feature-name
4

Make your changes

Implement your feature or fix
5

Test your changes

pytest
6

Commit and push

git add .
git commit -m "Add: description of your changes"
git push origin feature/your-feature-name
7

Create pull request

Open a pull request with a clear description of your changes

​
Code Style

  • Follow PEP 8 guidelines
  • Use black for code formatting
  • Use ruff for linting
  • Write docstrings for all public methods
  • Add type hints

​
Pull Request Guidelines

Use conventional commit format:
  • feat: for new features
  • fix: for bug fixes
  • docs: for documentation
  • refactor: for code refactoring
  • test: for adding tests
  • Explain what the PR does
  • Why the change is needed
  • How to test the changes
  • Link related issues
  • Code follows style guidelines
  • Tests added/updated
  • Documentation updated
  • All tests pass
  • No linter warnings

​
Questions?

Thank you for contributing! 🎉