Add five specialized Copilot agent instruction files for iSnobal org#11
Open
Add five specialized Copilot agent instruction files for iSnobal org#11
Conversation
…structions/ Co-authored-by: jomey <178649+jomey@users.noreply.github.com>
Copilot
AI
changed the title
Add specialized Copilot agent instruction files
Add five specialized Copilot agent instruction files for iSnobal org
Mar 19, 2026
There was a problem hiding this comment.
Pull request overview
Adds organization-wide GitHub Copilot agent instruction files under .github/instructions/ to guide specialized review across iSnobal repositories.
Changes:
- Introduces a snow-physics-focused review agent for two-layer snowpack model correctness and stability.
- Adds performance and dependency modernization agents focused on C/Cython efficiency and conda-first Python modernization.
- Adds testing/coverage and documentation agents to standardize test expectations and NumPy-style docstrings/RTD review.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
.github/instructions/snow-physics-agent.md |
Defines review focus areas for snow physics, numerical stability, and two-layer model logic. |
.github/instructions/performance-cython-agent.md |
Defines performance review guidance for C/Cython, memory management, and algorithmic complexity. |
.github/instructions/testing-coverage-agent.md |
Defines test organization/coverage guidance for pytest/unittest and review expectations. |
.github/instructions/dependency-modernization-agent.md |
Defines conda-first dependency management and modernization guidance (Mac/Linux focus). |
.github/instructions/documentation-agent.md |
Defines documentation review guidance for NumPy-style docstrings, RTD, and Markdown docs. |
Comments suppressed due to low confidence (2)
.github/instructions/dependency-modernization-agent.md:36
- These bullets conflict/are unclear: earlier guidance allows pip as a fallback when conda isn't available, but this line reads like "never mention pip". Please rephrase to distinguish between (a) allowing pip installs as a fallback and (b) avoiding pip-based packaging/distribution suggestions (setup.py/pyproject publishing).
- Do not suggest anything related to package via pip
- Review setup.py, pyproject.toml, and setup.cfg
.github/instructions/documentation-agent.md:21
- PR description specifies this agent should enforce "no Examples section" in NumPy-style docstrings, but there’s no instruction here to omit/avoid an Examples section. Please add an explicit guideline under Docstrings/Docstring Format to keep docstrings free of Examples (and where to put examples instead, if desired).
### Docstrings
- Verify all public functions/classes have docstrings
- Check docstring format follows NumPy style
- Validate parameter descriptions match function signature
- Ensure type hints and return hints are present
- Check for outdated docstrings after code changes
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
70f77c9 to
3f4b191
Compare
jomey
approved these changes
Mar 19, 2026
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.
Creates
.github/instructions/with five non-overlapping Copilot agent definitions for organization-wide use across all iSnobal repositories.Agents
snow-physics-agent.md— Two-layer snowpack model review: energy/mass balance, phase change, NWP forcing data, physically impossible statesperformance-cython-agent.md— C/Cython optimization, memory management (malloc/free, GIL release), NumPy vectorization, algorithmic complexitytesting-coverage-agent.md— pytest/unittest coverage; central fixture base; minimal inline comments; targets both changed and previously untested code sectionsdependency-modernization-agent.md— Conda-first (pip as fallback only), Mac/Linux only, modern Python syntax (f-strings, type hints, dataclasses), no pip packaging suggestionsdocumentation-agent.md— NumPy-style docstrings with type/return hints; noExamplessection; README and ReadTheDocs reviewOriginal prompt
Create five specialized Copilot agent instruction files in the
.github/instructions/directory for organization-wide use across all iSnobal repositories.Files to Create
1.
.github/instructions/snow-physics-agent.md2.
.github/instructions/performance-cython-agent.md3.
.github/instructions/testing-coverage-agent.md