Repository navigation
docs: add AGENTS.md for coding agents - #46
Merged
Merged
Conversation
Document release flow, CI expectations, and cross-model test_models contract. Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
AGENTS.md contains inaccurate or inconsistent workflow and testing documentation that should be corrected.
Review effort: Lite
Findings: 1
Open (1)
What changed in this PR
Adds a root AGENTS.md documenting repository conventions, releases, CI, and cross-model testing.
Changes:
- Documents Conventional Commits and release workflow.
- Summarizes CI and local testing.
- Defines cross-model testing expectations.
| File | Review findings |
|---|---|
AGENTS.md |
Four nit findings: clarify pre-commit scope (1 vote), correct make verify-ci commands (3 votes), fix the exog-test path (1 vote), and reconcile model test-marking guidance (1 vote). |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| | **test-docs** | Executable markdown in `docs/` (except changelog files), `README.md`, and Python docstrings via `mktestdocs`. | | ||
| | **build-docs** | `mkdocs build` | | ||
| | **lint** | Full `pre-commit` (ruff, mypy on `foundationforecast/` only—`experiments/` excluded) | | ||
| | **test-gift-eval** | Modal GPU run for [`configs/ci_subset.yaml`](experiments/gift-eval/configs/ci_subset.yaml), then `make verify-ci` (S3 sync + strict per-job MASE/CRPS vs Hugging Face references). | |
Co-authored-by: Cursor <cursoragent@cursor.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
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.
Summary
AGENTS.mdwith conventional commits, release steps (chore(release): vX.Y.Z+gh release create), and CI overview.tests/models/test_models.pyfor allconftest.pymodels; new models join that list.Test plan
Made with Cursor