Skip to content

[Improvement] Add contributor docs, AI assistant rules, and fix helm-lint#293

Open
GiladShapira94 wants to merge 28 commits intomlrun:developmentfrom
GiladShapira94:small-improvemnts
Open

[Improvement] Add contributor docs, AI assistant rules, and fix helm-lint#293
GiladShapira94 wants to merge 28 commits intomlrun:developmentfrom
GiladShapira94:small-improvemnts

Conversation

@GiladShapira94
Copy link
Copy Markdown
Collaborator

📝 Description

This PR improves the contributor and AI-assistant developer experience for the MLRun CE repository.
It adds CONTRIBUTING.md (new file) and significantly expands AGENTS.md with a Quick-Start Dev Workflow, Component Dependency Map, and "How to Add a New Component" guide.
A .cursorrules file is introduced for Cursor IDE users, mirroring the conventions in AGENTS.md.
The make helm-lint command is fixed with --validate-maintainers=false and --helm-extra-args "--timeout 600s" flags, and a missing trailing newline in Chart.yaml that caused yamllint failures is resolved.


🛠️Changes Made

  • CONTRIBUTING.md (new) — contributor guide covering prerequisites, dev workflow, commit/PR title format, three testing levels (lint, dry-run, Kind e2e), and release process
  • .cursorrules (new) — Cursor IDE rules mirroring AGENTS.md/CLAUDE.md conventions; includes manual equivalents of /render, /bump, /pr Claude Code skills
  • AGENTS.md — added Quick-Start Dev Workflow, Component Dependency Map table, and "How to Add a New Component" step-by-step guide.
  • CLAUDE.md — added @CONTRIBUTING.md import and Preferred Response Patterns section with Claude-specific behavioral rules
  • Makefilect lint updated with --validate-maintainers=false --helm-extra-args "--timeout 600s" to prevent false lint failures on local dev
  • charts/mlrun-ce/Chart.yaml — version bumped 0.11.0-rc.340.11.0-rc.35; fixed missing trailing newline (resolved yamllint new-line-at-end-of-file error)
  • .gitignore — added .claude/settings.local.json (machine-specific, not for commit)
  • charts/mlrun-ce/README.md — minor whitespace cleanup (extra blank line before "Using Kubeflow Pipelines")

✅ Checklist

  • I have tested the changes in this PR
  • I confirmed whether my changes require a change in documentation and if so, I created another PR in MLRun for the relevant documentation.
  • I confirmed whether my changes require a changes in QA tests, for example: credentials changes, resources naming change and if so, I updated the relevant Jira ticket for QA.
  • I increased the Chart version in charts/mlrun-ce/Chart.yaml.
  • I confirmed that the installation works both on a local Docker Desktop environment and on a real cluster when using the required
    prerequisites.
    • If installation issues were found, I updated the relevant Jira ticket with the issue and steps to reproduce, or updated the prerequisites documentation if the issue is related to missing or outdated prerequisites.
  • If needed, update https://github.com/mlrun/ce/blob/development/charts/mlrun-ce/README.md with the relevant installation instructions and version Matrix.
  • If needed, update the following values files for multi namespace support:

🧪 Testing

Changes are documentation and tooling only — no Kubernetes resources or chart values were modified.
make helm-lint was verified passing locally with the updated ct lint flags and the Chart.yaml trailing-newline fix.
No cluster deployment is required for this change.


🚨 Breaking Changes?

  • Yes (explain below)
  • No

@GiladShapira94 GiladShapira94 requested a review from royischoss May 4, 2026 11:30
@GiladShapira94 GiladShapira94 changed the title [Improvement] Add contributor docs, AI assistant rules, and fix helm-lint [improvement] Add contributor docs, AI assistant rules, and fix helm-lint May 4, 2026
@GiladShapira94 GiladShapira94 changed the title [improvement] Add contributor docs, AI assistant rules, and fix helm-lint [Improvement] Add contributor docs, AI assistant rules, and fix helm-lint May 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant