Skip to content

chore: repo health#15

Merged
dmadisetti merged 1 commit into
mainfrom
dm/health
Apr 17, 2026
Merged

chore: repo health#15
dmadisetti merged 1 commit into
mainfrom
dm/health

Conversation

@dmadisetti
Copy link
Copy Markdown
Collaborator

No description provided.

Copilot AI review requested due to automatic review settings April 17, 2026 18:51
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR improves repository hygiene and contributor experience by adding standard community/maintenance files (security policy, contributing guidance, templates) and introducing pre-commit tooling.

Changes:

  • Add SECURITY policy and expand contributing documentation for Go operator + Python plugin workflows.
  • Introduce pre-commit configuration and add GitHub PR/issue templates.
  • Add CLAUDE.md with repo-specific build/test and architecture guidance.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
SECURITY.md Adds a security policy and vulnerability reporting process.
CONTRIBUTING.md Expands contributor setup/workflow docs for operator + plugin.
CLAUDE.md Adds AI-tooling guidance including build/test commands and architecture notes.
.pre-commit-config.yaml Adds pre-commit hooks for whitespace/YAML checks, Ruff, and Go formatting/vetting.
.github/pull_request_template.md Adds a PR template with a checklist covering tests/linting and generated files.
.github/ISSUE_TEMPLATE/bug_report.yaml Adds a structured bug report form.
.github/ISSUE_TEMPLATE/feature_request.yaml Adds a structured feature request form.
.github/ISSUE_TEMPLATE/config.yml Adds issue creation config + community contact links.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CLAUDE.md

```bash
cd plugin
uv sync --dev # Install dev dependencies
Copy link

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

plugin/pyproject.toml exposes dev dependencies as an optional extra ([project.optional-dependencies].dev), and CI uses uv sync --extra dev. Using uv sync --dev here may not install the extra, causing pytest/ty to be missing. Update this command to match the project/CI install method.

Suggested change
uv sync --dev # Install dev dependencies
uv sync --extra dev # Install dev dependencies

Copilot uses AI. Check for mistakes.
Comment thread CONTRIBUTING.md

| Tool | Purpose |
|------|---------|
| [Go](https://go.dev) ≥ 1.22 | Operator development |
Copy link

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The stated Go prerequisite (≥ 1.22) doesn't match the module requirement in go.mod (go 1.24.6). Contributors using Go 1.22/1.23 will fail to build/test; update the documented minimum to the version declared in go.mod (or lower the go directive if 1.22 is actually intended).

Suggested change
| [Go](https://go.dev) ≥ 1.22 | Operator development |
| [Go](https://go.dev) ≥ 1.24.6 | Operator development |

Copilot uses AI. Check for mistakes.
Comment thread CONTRIBUTING.md
git clone https://github.com/marimo-team/marimo-operator.git
cd marimo-operator/plugin
cd plugin
uv sync --dev
Copy link

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

plugin/pyproject.toml defines dev as an optional extra under [project.optional-dependencies], and CI installs it via uv sync --extra dev (see .github/workflows/plugin-test.yml:32). uv sync --dev likely won't install the dev extra, so the documented setup may miss pytest/ty. Align the docs with CI (e.g., use uv sync --extra dev).

Suggested change
uv sync --dev
uv sync --extra dev

Copilot uses AI. Check for mistakes.
@dmadisetti dmadisetti merged commit 0d06c2b into main Apr 17, 2026
10 checks passed
@dmadisetti dmadisetti deleted the dm/health branch April 17, 2026 20:33
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.

2 participants