chore: repo health#15
Conversation
There was a problem hiding this comment.
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.mdwith 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.
|
|
||
| ```bash | ||
| cd plugin | ||
| uv sync --dev # Install dev dependencies |
There was a problem hiding this comment.
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.
| uv sync --dev # Install dev dependencies | |
| uv sync --extra dev # Install dev dependencies |
|
|
||
| | Tool | Purpose | | ||
| |------|---------| | ||
| | [Go](https://go.dev) ≥ 1.22 | Operator development | |
There was a problem hiding this comment.
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).
| | [Go](https://go.dev) ≥ 1.22 | Operator development | | |
| | [Go](https://go.dev) ≥ 1.24.6 | Operator development | |
| git clone https://github.com/marimo-team/marimo-operator.git | ||
| cd marimo-operator/plugin | ||
| cd plugin | ||
| uv sync --dev |
There was a problem hiding this comment.
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).
| uv sync --dev | |
| uv sync --extra dev |
No description provided.