Skip to content
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,50 @@ pre-commit install
# 5. Run tests
cd test/unit
python -m pytest -v

```

## Supported Environments

To help contributors get started quickly, below is a summary of supported environments and testing expectations.

### Python Support
Metaflow primarily supports Python versions:

- Python 3.9+
- Recommended: Python 3.10 or newer
Comment thread
greptile-apps[bot] marked this conversation as resolved.
Outdated

Please ensure your local environment matches one of the supported versions.

---

### R Support
Metaflow includes limited support for R components. However:

- Most development and testing workflows are Python-focused
- R support may not be fully covered in CI

Contributors working on R-related features should validate changes locally.
Comment thread
greptile-apps[bot] marked this conversation as resolved.
Outdated

---

### CI Validation
Continuous Integration (CI) runs automated tests on:

- Supported Python versions (via GitHub Actions)
- Core functionality and workflows

CI ensures that contributions do not break existing functionality.

---

### Local Testing Guide

Before submitting a PR, contributors should run:

```bash
pip install -e .
pytest
**That's it!** Now read the requirements below before submitting your PR.
Comment thread
greptile-apps[bot] marked this conversation as resolved.

## PR Requirements (READ THIS FIRST)
Expand Down