Skip to content

Add support matrix and contributor environment clarity#3128

Open
AshishPadala wants to merge 7 commits intoNetflix:masterfrom
AshishPadala:docs-support-matrix
Open

Add support matrix and contributor environment clarity#3128
AshishPadala wants to merge 7 commits intoNetflix:masterfrom
AshishPadala:docs-support-matrix

Conversation

@AshishPadala
Copy link
Copy Markdown

PR Type

PR Type

  • Bug fix
  • New feature
  • Core Runtime change (higher bar -- see CONTRIBUTING.md)
  • Docs / tooling
  • Refactoring

Summary

Added a "Supported Environments" section to CONTRIBUTING.md to clarify Python version support, CI validation, and local testing expectations for contributors.

Issue

Closes #3109

Reproduction

N/A — this is a documentation-only change.

Root Cause

N/A — no runtime behavior is affected.

Why This Fix Is Correct

This change improves clarity for contributors by consolidating environment support and testing expectations into a single structured section in the documentation.

Failure Modes Considered

N/A — no runtime or functional changes.

Tests

  • Unit tests added/updated
  • Reproduction script provided (required for Core Runtime)
  • CI passes
  • If tests are impractical: explain why below and provide manual evidence above

This is a documentation-only change, so no tests are required.

Non-Goals

This change does not modify any runtime behavior, CI logic, or existing functionality. It only improves contributor documentation.

AI Tool Usage

  • AI tools were used (describe below)

Used AI assistance to help structure and refine documentation content. All changes were reviewed and verified manually.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 18, 2026

Greptile Summary

This documentation-only PR adds a "Supported Environments" section to CONTRIBUTING.md and introduces a new scripts/check_metadata.py script (wired into CI) to cross-check name/version fields across setup.cfg, setup.py, and metaflow/version.py. Previously flagged issues — the broken code fence, the Python version contradiction with CI, and the misleading R CI claim — all appear resolved in the current revision.

Confidence Score: 5/5

Safe to merge; all prior P1 issues are resolved and the one remaining finding is a minor P2 documentation inconsistency.

All previously flagged blocking issues (missing code fence, Python version mismatch, incorrect R CI claim) have been addressed. The only new finding is a P2 inconsistency in the test command suggested in the Local Testing Guide versus the Quick Start section.

CONTRIBUTING.md — Local Testing Guide test command should match the Quick Start section

Important Files Changed

Filename Overview
CONTRIBUTING.md Adds a "Supported Environments" section; previously flagged issues (code fence, Python version, R CI claim) appear resolved, but Local Testing Guide uses inconsistent test command vs Quick Start
scripts/check_metadata.py New script to cross-check name/version across setup.cfg, setup.py, and version.py; correctly warns and exits 0 when setup.cfg has no checkable fields (which is the current state of the repo)
.github/workflows/test.yml Adds a CI step to run check_metadata.py; step is benign given current setup.cfg structure (exits 0 with warning), no functional regressions introduced

Reviews (6): Last reviewed commit: "Align R support documentation with CI co..." | Re-trigger Greptile

Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md Outdated
Comment thread scripts/check_metadata.py
Comment thread CONTRIBUTING.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: clarify language/runtime support matrix for contributors

1 participant