Implementation:Kubeflow Kubeflow Contributing Redirect
| Knowledge Sources | |
|---|---|
| Domains | Contributor Onboarding, Documentation, GitHub Configuration |
| Last Updated | 2026-02-13 00:00 GMT |
Overview
Concrete tool for directing contributors to the canonical contribution guide provided by the Kubeflow CONTRIBUTING.md HTTP redirect pattern.
Description
The CONTRIBUTING.md file in the kubeflow/kubeflow repository is a lightweight document that welcomes contributors and provides a single link to the full contributor guide hosted at https://www.kubeflow.org/docs/about/contributing/. GitHub automatically surfaces this file in the repository UI when contributors create issues or open pull requests, making it the primary entry point for contribution guidance.
The file deliberately avoids duplicating the full contributor guide content. Instead, it follows a redirect pattern where the repository file serves as a pointer to the authoritative source on the Kubeflow website. This ensures that updates to contribution policies propagate immediately to all contributors without requiring changes to individual repository files.
Usage
Use this implementation when:
- A contributor navigates to the
CONTRIBUTING.mdfile in the Kubeflow repository. - GitHub displays the contribution guidelines link in the issue or PR creation interface.
- Setting up a new Kubeflow sub-project repository that needs to point to the canonical guide.
- Verifying that the redirect URL is still valid and points to the current contributor guide.
Code Reference
Source Location
- Repository: kubeflow/kubeflow
- File:
CONTRIBUTING.md(Lines 1-6)
Signature
# Kubeflow Contributor Guide
Welcome to the Kubeflow project!
We'd love to accept your patches and contributions to this project.
Please see our [contributor guide](https://www.kubeflow.org/docs/about/contributing/) for more information on how to get started.
Import
# CONTRIBUTING.md is automatically recognized by GitHub.
# No installation required. To view the file:
curl -s https://raw.githubusercontent.com/kubeflow/kubeflow/master/CONTRIBUTING.md
# To follow the redirect and access the full guide:
xdg-open https://www.kubeflow.org/docs/about/contributing/
I/O Contract
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
| Contributor navigation | User action | Yes | A contributor navigates to the repository's CONTRIBUTING.md file or encounters it via GitHub's issue/PR creation UI. |
| Redirect URL | string (URL) | Yes | The target URL for the canonical guide: https://www.kubeflow.org/docs/about/contributing/
|
Outputs
| Name | Type | Description |
|---|---|---|
| Welcome message | Rendered Markdown | GitHub renders the CONTRIBUTING.md content showing a welcome message and the redirect link. |
| Redirect to canonical guide | HTTP navigation | Clicking the contributor guide link navigates the user to the full guide on kubeflow.org. |
| Full contribution guidelines | Web page | The canonical guide at kubeflow.org provides complete DCO, coding standards, PR workflow, and review process documentation. |
Usage Examples
Example: Contributor Follows the Redirect
# Step 1: Contributor discovers CONTRIBUTING.md via GitHub UI
# GitHub shows "Read our contributing guidelines" link when creating a PR
# Step 2: Contributor clicks through to the full guide
# Browser navigates to: https://www.kubeflow.org/docs/about/contributing/
# Step 3: Contributor reads the full guide covering:
# - Developer Certificate of Origin (DCO) sign-off
# - Code review and OWNERS process
# - Coding standards and style guides
# - CI/CD requirements
# - Community communication channels
Example: Setting Up CONTRIBUTING.md for a New Sub-Project
# Create the same redirect pattern in a new Kubeflow sub-project
cat > CONTRIBUTING.md << 'EOF'
# Kubeflow Contributor Guide
Welcome to the Kubeflow project!
We'd love to accept your patches and contributions to this project.
Please see our [contributor guide](https://www.kubeflow.org/docs/about/contributing/) for more information on how to get started.
EOF
git add CONTRIBUTING.md
git commit -s -m "Add CONTRIBUTING.md with redirect to canonical guide"