chore: add contributor/agent harness#286
Merged
Merged
Conversation
Adapt the opik-examples harness to this repo: agent guardrails, Comet-accurate conventions, a starter template, and a scaffolder. Tailored to this repo's reality (comet_ml, requirements.txt + Poetry, kebab-case folders, the CI matrix) rather than copied verbatim. - .claude/settings.json: deny destructive git, gh pr merge/close/review, .env reads - AGENTS.md / CONTRIBUTING.md: Comet SDK idiom, env creds, optional offline mode, README house structure, CI-matrix instructions - templates/integration-example: minimal runnable comet_ml example - .claude/skills/scaffold-example: stamps the template, renames sentinels - readme.md: repository structure + contributing sections; fix stale tutorial links
New examples are uv projects with a pyproject.toml; existing requirements.txt examples are legacy and stay as they are. Update the template, the scaffolder, and the AGENTS/CONTRIBUTING conventions to match, and note that the pip-based CI matrix still needs a requirements.txt for a uv example to be covered.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a contributor + AI-agent harness so new examples land in a consistent, documented shape.
.claude/settings.json— agent guardrails: deny destructive git (reset --hard,rebase,merge,branch -D),gh pr merge/close/review, and.envreads.AGENTS.md/CONTRIBUTING.md— conventions for agents and humans: thecomet_ml.login()+start()idiom, env-var credentials, optional offline mode, the house README structure, kebab-case naming, and how to wire an example into CI.templates/integration-example/— a minimal, runnablecomet_mlexample (uv+pyproject.toml) to start new examples from..claude/skills/scaffold-example/— a skill + generator that stamps the template into the right directory and renames it.readme.md— adds repository-structure and contributing sections; fixes stale tutorial links to the currentintegrations/model-training/...paths..gitignore— adds.ruff_cache/,.tmp/,*-workspace/.Conventions
uvprojects: dependencies inpyproject.toml, run withuv run. Existingrequirements.txtexamples are legacy and stay as they are.COMET_MODE=offline) documented as the no-account path.integrations/<category>/<framework>/.test-examples.yml) still installs viapip install -r requirements.txt, so a newuvexample that wants CI coverage also ships arequirements.txt(uv export).Verification
scaffold.py keras-amp-demo --description "..."→ correct folder/file/project rename, description written topyproject.toml, no leftover sentinels.settings.jsonvalid JSON;pyproject.tomlvalid TOML.integrations/...paths exist; pre-commit (ruff-format) clean.