chore: Custom copilot instructions for building models

[toby-coleman]

Summary

Custom copilot instructions to help users build models.

Changes

• model.instructions.md file added - see here for more info.

[gemini-code-assist]

Summary of Changes

Hello @toby-coleman, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

I've introduced custom Copilot instructions to guide users in building models within the Plugboard framework. This change aims to streamline the model development process by providing context-aware assistance directly within the coding environment, making it easier for users to plan, implement, connect, and run their models.

Highlights

• Custom Copilot Instructions: A new file, .github/instructions/models.instructions.md, has been added. This file contains detailed instructions for GitHub Copilot, specifically tailored to assist users in planning, implementing components, connecting components into a process, and running models within the Plugboard framework. The instructions include code examples for common tasks.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds custom Copilot instructions to guide users in building models with the plugboard framework. The instructions are well-structured, but some of the Python code examples have issues that could confuse users and Copilot. I've identified a few areas for improvement: one of the code snippets is missing necessary imports, another uses undefined components without explanation, and a third refers to a function that doesn't seem to exist in the codebase. Addressing these points will make the instructions much more accurate and helpful.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!