-
Notifications
You must be signed in to change notification settings - Fork 3
Contributing
Manu Murugesan edited this page Mar 13, 2026
·
1 revision
Contributions to medicaid-utils are welcome! Here's how to get started.
# Clone the repository git clone https://github.com/uc-cms/medicaid-utils.git cd medicaid-utils # Install in development mode pip install -e . # Install development dependencies pip install pylint pytest
# Run the full test suite (316 tests) pytest tests/ # Run tests for a specific module pytest tests/preprocessing/ pytest tests/adapted_algorithms/ # Run a specific test file pytest tests/adapted_algorithms/py_elixhauser/test_elixhauser.py # Run with verbose output pytest -v tests/
# Run the linter
pylint medicaid_utilsThe CI pipeline runs both pylint and pytest on Python 3.11, 3.12, and 3.13 for every push.
- Fork the repository
- Create a feature branch:
git checkout -b my-feature - Make your changes
- Run tests:
pytest tests/ - Run linter:
pylint medicaid_utils - Commit your changes with a descriptive message
- Push to your fork and open a pull request
Open an issue on GitHub with:
- Python version and medicaid-utils version
- Minimal code example that reproduces the issue
- Full error traceback
- Description of expected vs. actual behavior
- Follow existing patterns in the codebase
- Use type hints for function signatures
- Add docstrings in NumPy format
- Keep functions focused and avoid over-engineering
Getting Started
User Guide
Recipes & How-Tos
Reference
Links