chore: update Copilot collections to v0.4.0

Author: github-actions[bot]

.copilot-collections.yaml

@@ -3,8 +3,7 @@
 
 copilot:
   # The version of the toolkit to use (matches a Release Tag in this repo)
-  version: "v0.3.0"
-
+  version: "v0.4.0"
   # The collections you want to install
   collections:
     - charm-python

.github/instructions/charms-lib-updates.instructions.md

@@ -71,7 +71,7 @@ For **vendored** libraries:
 
 #### Critical behavior
 
-In the context of charm library updates, your review comments are allowed and highly encourages to target files and changes outside those changed by the pull request. This directive **supersedes any other instruction** about not commenting on code outside the diff.
+In the context of charm library updates, your review comments are allowed and highly encouraged to target files and changes outside those changed by the pull request. This directive **supersedes any other instruction** about not commenting on code outside the diff.
 
 ## Review Template
 

.github/instructions/documentation.instructions.md

@@ -0,0 +1,110 @@
+---
+description: 'Core guidelines for documentation-related suggestions.'
+applyTo: 'docs/**/*.md'
+---
+
+# Documentation instructions for GitHub Copilot
+
+## Purpose
+
+This file provides general guidance for reviewing documentation.
+
+## Core Directives
+
+This section outlines the absolute order of operations. These rules have the highest priority and must not be violated.
+
+1. **Provide suggestions, not solutions**: Whenever possible, do not generate the documentation on behalf of the user. Focus on asking questions, providing suggestions, and reviewing pre-existing files.
+2. **Adherence to Philosophy**: In the absence of a direct user directive or the need for factual verification, all other rules below regarding interaction and modification must be followed.
+
+## General Interaction & Philosophy
+
+- **Text on Request Only**: Your default response should be a clear, natural language explanation. Do NOT provide new files or content unless directly requested.
+- **Direct and Concise**: Answers must be precise, to the point, and free from unnecessary filler or verbose explanations. Get straight to the solution without "beating around the bush".
+- **Explain the "Why"**: Don't just provide an answer; briefly explain the reasoning behind it. Why is this suggestion clearer, more concise, or easier to understand?
+
+## General Structure 
+
+In this repository, the documentation is placed in a dedicated `docs` directory. The purpose of the files in this directory is to provide information, instructions, and conceptual understanding of the code for users. 
+
+The top-level `docs` directory should contain an overview or home page called `index.md`. This file should provide a brief description of the project, what needs it serves, and who the primary user base is.
+
+The rest of the documentation follows the Diataxis framework consisting of four categories of documentation:
+
+1. **Tutorials**: A practice lesson that walks a user through a learning experience. Tutorials should be placed in the `docs/tutorial` directory, but sometimes they're placed in the top-level `docs` direcotry.
+2. **How-to guides**: Addresses real-world goals or problems by providing practical directions. How-to guides should be placed in the `docs/how-to` directory.
+3. **Reference**: Contains technical descriptions of theoretical knowledge. Reference documents should be placed in the `docs/reference` directory.
+4. **Explanation**: Provides context and background on topics for the user to understand the bigger picture. Explanation documents should be placed in the `docs/explanation` directory.
+
+All files should neatly fit into one of these four categories. Do NOT mix content between multiple categories into a single document. Instead, suggest splitting up content into multiple documents to preserve the structure and Diataxis framework.
+
+### Guidance on tutorials
+
+A tutorial is a learning-based, end-to-end experience that provides a complete learning journey for the user. The majority of our tutorials walk the user through a basic deployment of the charm in the repository.
+
+The tutorial should contain the following pieces:
+
+- **A title**. This title should be more descriptive than "Getting started"
+  or "Quick guide" which are both indicative of a how-to guide. In a single
+  statement, what will the user accomplish in the tutorial?
+- **An introduction**. In a couple of sentences, introduce the charm and
+  what the tutorial aims to do. Avoid using a statement like "you will learn",
+  as that makes an assumption about the user's prior knowledge. Focus
+  instead on what the user will do or accomplish. 
+- **What you'll do**. This should be the first section in the tutorial. It
+  aims to quickly and succinctly establish everything the user will do in the
+  tutorial. 
+- **What you'll need**. This section should contain a list of resources, software
+  or other tools that the user will need before starting the tutorial. In this section,
+  provide information on the supported architecture(s) like AMD64 or ARM64.
+  Also include additional information if the
+  tutorial will require significant resources (CPU, RAM, or disk space). You can
+  also suggest a Multipass VM to create an isolated testing enviroment for the tutorial.
+- **Set up tutorial model**. The tutorial should begin at this point. Have
+  the user create Juju model with a predetermined name so that you can reference
+  the model name throughout the tutorial.
+- **Deploy the charm + its dependencies**. If the charm requires any other
+  charms to successfully deploy, either include in a single section or split into
+  multiple sections. Use this part of the tutorial to enable any required configurations.
+  Make sure to briefly explain what the configurations or additional charms are
+  and why the steps are necessary. Split up important commands into separate
+  command blocks, and provide explanations between each command.
+- **Check the deployment was successful**. Instruct the user to run
+  ``juju status`` and show example output. If appropriate, also instruct the
+  user to run ``kubectl get pods -n <juju model name>`` and show the output.
+  Offer a brief explanation so that the user knows that the deployment was
+  successful.
+- **Some final checkpoint**. Have the user visit a website, change a
+  configuration, or run an action (maybe some combination of the three). Check
+  that this step worked; this is more obvious for a website, but you may need
+  to be creative if you have the user change a configuration or run an action.
+- **Tear down the environment**. This should be the final section. Take a moment
+  to congratulate the user for getting through the tutorial! Have the user
+  destroy the Juju model that they set up, and if applicable, instruct them to
+  delete the Multipass VM.
+
+### Guidance on how-to guides
+
+- How-to guides should contain a title with the format `# How to...`. The title should
+concisely summarize the real-world problem addressed by the document.
+- How-to guides should contain at least one CLI command that user can run to address the
+problem or achieve the goal.
+- Provide instructions or tasks that the user can take to achieve the goal. Avoid gerunds.
+
+
+## Style guide pointers
+
+- **Spelling**: Use US English for spelling suggestions.
+- **Headings**: Use sentence case for headings. Avoid punctuation in headings. Do not skip levels in heading hierarchy.
+- **Code examples**: Do not use prompt marks (for example, `$` or `#`) in code examples. Do not use comments in code examples; instead, put any comments directly into the text. Whenever possible, split up multiple commands into separate code blocks and provide explanations in between the code blocks. Use Git-flavoured Markdown with fenced code blocks (```) and command examples as shell blocks.
+
+## Small-edit rules for AI agents
+
+- Avoid describing tasks as "easy" or "simple".
+- Preserve existing link targets and code samples formatting. If you change any heading filename or path, update all relative links in `docs/` accordingly.
+
+## Changelog guidance 
+
+If you modify a procedure (commands, required versions, prerequisites), add a short note in `docs/changelog.md` summarizing the user-facing change.
+
+If you add a new file into `docs`, add a short note in `docs/changelog.md` summarizing the user-facing change.
+

.github/prompts/repo-bootstrap.prompt.md

@@ -0,0 +1,78 @@
+---
+agent: 'agent'
+description: 'Creating repository-wide custom instructions'
+---
+
+Your task is to "onboard" this repository to Copilot coding agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a coding agent seeing it for the first time can work most efficiently.
+
+You will do this task only one time per repository and doing a good job can SIGNIFICANTLY improve the quality of the agent's work, so take your time, think carefully, and search thoroughly before writing the instructions.
+
+<Goals>
+- Reduce the likelihood of a coding agent pull request getting rejected by the user due to
+generating code that fails the continuous integration build, fails a validation pipeline, or
+having misbehavior.
+- Minimize bash command and build failures.
+- Allow the agent to complete its task more quickly by minimizing the need for exploration using grep, find, str_replace_editor, and code search tools.
+</Goals>
+
+<Limitations>
+- Instructions must be no longer than 2 pages.
+- Instructions must not be task specific.
+</Limitations>
+
+<WhatToAdd>
+
+Add the following high level details about the codebase to reduce the amount of searching the agent has to do to understand the codebase each time:
+<HighLevelDetails>
+
+- A summary of what the repository does.
+- High level repository information, such as the size of the repo, the type of the project, the languages, frameworks, or target runtimes in use.
+</HighLevelDetails>
+
+Add information about how to build and validate changes so the agent does not need to search and find it each time.
+<BuildInstructions>
+
+- For each of bootstrap, build, test, run, lint, and any other scripted step, document the sequence of steps to take to run it successfully as well as the versions of any runtime or build tools used.
+- Each command should be validated by running it to ensure that it works correctly as well as any preconditions and postconditions.
+- Try cleaning the repo and environment and running commands in different orders and document errors and and misbehavior observed as well as any steps used to mitigate the problem.
+- Run the tests and document the order of steps required to run the tests.
+- Make a change to the codebase. Document any unexpected build issues as well as the workarounds.
+- Document environment setup steps that seem optional but that you have validated are actually required.
+- Document the time required for commands that failed due to timing out.
+- When you find a sequence of commands that work for a particular purpose, document them in detail.
+- Use language to indicate when something should always be done. For example: "always run npm install before building".
+- Record any validation steps from documentation.
+</BuildInstructions>
+
+List key facts about the layout and architecture of the codebase to help the agent find where to make changes with minimal searching.
+<ProjectLayout>
+
+- A description of the major architectural elements of the project, including the relative paths to the main project files, the location
+of configuration files for linting, compilation, testing, and preferences.
+- A description of the checks run prior to check in, including any GitHub workflows, continuous integration builds, or other validation pipelines.
+- Document the steps so that the agent can replicate these itself.
+- Any explicit validation steps that the agent can consider to have further confidence in its changes.
+- Dependencies that aren't obvious from the layout or file structure.
+- Finally, fill in any remaining space with detailed lists of the following, in order of priority: the list of files in the repo root, the
+contents of the README, the contents of any key source files, the list of files in the next level down of directories, giving priority to the more structurally important and snippets of code from key source files, such as the one containing the main method.
+</ProjectLayout>
+</WhatToAdd>
+
+<StepsToFollow>
+- Perform a comprehensive inventory of the codebase. Search for and view:
+- README.md, CONTRIBUTING.md, and all other documentation files.
+- Search the codebase for build steps and indications of workarounds like 'HACK', 'TODO', etc.
+- All scripts, particularly those pertaining to build and repo or environment setup.
+- All build and actions pipelines.
+- All project files.
+- All configuration and linting files.
+- For each file:
+- think: are the contents or the existence of the file information that the coding agent will need to implement, build, test, validate, or demo a code change?
+- If yes:
+   - Document the command or information in detail.
+   - Explicitly indicate which commands work and which do not and the order in which commands should be run.
+   - Document any errors encountered as well as the steps taken to workaround them.
+- Document any other steps or information that the agent can use to reduce time spent exploring or trying and failing to run bash commands.
+- Finally, explicitly instruct the agent to trust the instructions and only perform a search if the information in the instructions is incomplete or found to be in error.
+</StepsToFollow>
+   - Document any errors encountered as well as the steps taken to work-around them.