Skip to content

Add seven specialized Copilot agent instruction files for iSnobal org#11

Open
Copilot wants to merge 4 commits intomainfrom
copilot/create-instructions-for-copilot-agents
Open

Add seven specialized Copilot agent instruction files for iSnobal org#11
Copilot wants to merge 4 commits intomainfrom
copilot/create-instructions-for-copilot-agents

Conversation

Copy link
Copy Markdown

Copilot AI commented Mar 19, 2026

Add different agents for various tasks. This is an experiment to make use of Copilot to perform model maintenance and improvements.

@jomey jomey changed the title [WIP] Add specialized Copilot agent instruction files Add specialized Copilot agent instruction files Mar 19, 2026
Copilot AI changed the title Add specialized Copilot agent instruction files Add five specialized Copilot agent instruction files for iSnobal org Mar 19, 2026
Copilot AI requested a review from jomey March 19, 2026 21:09
@jomey jomey requested a review from Copilot March 19, 2026 21:46
@jomey jomey marked this pull request as ready for review March 19, 2026 21:46
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

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.

@jomey jomey force-pushed the copilot/create-instructions-for-copilot-agents branch from 70f77c9 to 3f4b191 Compare March 19, 2026 22:09
@jomey jomey requested a review from a team March 20, 2026 22:33
Copilot AI requested a review from jomey April 3, 2026 20:41
Copilot finished work on behalf of jomey April 3, 2026 20:41
@jomey jomey changed the title Add five specialized Copilot agent instruction files for iSnobal org Add seven specialized Copilot agent instruction files for iSnobal org Apr 3, 2026
Copilot stopped work on behalf of jomey due to an error April 3, 2026 20:45
@jomey jomey requested a review from Hedrick-ARS April 3, 2026 20:55
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.

3 participants