Skip to content

docs: Update Copilot agent instructions to reflect current project state#347

Merged
Mikefly123 merged 8 commits intomainfrom
copilot/update-copilot-instructions
Apr 1, 2026
Merged

docs: Update Copilot agent instructions to reflect current project state#347
Mikefly123 merged 8 commits intomainfrom
copilot/update-copilot-instructions

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 27, 2026

The Copilot instructions were outdated, missing ~20 components, numerous Makefile targets, and several key subsystems added since the last update.

Changes

Corrections

  • Fix default board: v5cv5d (was inconsistent with settings.ini)
  • Fix config filename: fprime-gds.yamlfprime-gds.yml

Component inventory — expanded from 6 to 27+ components, organized by category:

  • ADCS & Control, Communication (AmateurRadio, SBand, ComCcsds*), Core System (ModeManager, StartupManager, ResetManager), Hardware Drivers (Drv2605, Ina219, Tmp112, Veml6031), Hardware Control (AntennaDeployer, Burnwire, CameraHandler, LoadSwitch), Storage (FlashWorker, FsFormat, FsSpace, NullPrmDb), Security (Authenticate, AuthenticationRouter)

Directory structure — added bootloader/, Framing/, sequences/, scripts/, tools/, and lib/fprime-extras/ submodule

Makefile targets — added 15+ undocumented targets:

  • make data-budget [VERBOSE=1] — telemetry data budget analysis
  • make docs-sync/serve/build — MkDocs documentation workflow
  • make test-unit, make test-interactive — additional test modes
  • make sequence SEQ=<name> — compile .seq files from sequences/
  • make framer-plugin, make generate-auth-key, make build-mcuboot, make copy-secrets

New sections

  • Development Tools — documents tools/data_budget.py for downlink budget planning
  • Framing Plugin — CCSDS framing plugin in Framing/ required for gds-integration
  • Command Sequences — operational .seq files and how to compile/upload them
  • Authentication & Security — HMAC key generation and MCUBoot firmware signing workflow

Related Issues/Tickets

How Has This Been Tested?

  • Unit tests
  • Integration tests
  • Z Tests
  • Manual testing — verified all referenced Makefile targets and filenames against current Makefile, lib/makelib/*.mk, and repository tree

Screenshots / Recordings (if applicable)

Checklist

  • Written detailed sdd with requirements, channels, ports, commands, telemetry defined and correctly formatted and spelled
  • Have written relevant integration tests and have documented them in the sdd
  • Have done a code review with
  • Have tested this PR on every supported board with correct board definitions

Further Notes / Considerations

The instructions reference lib/fprime-extras which is listed in settings.ini as a library_locations entry but may not be a tracked submodule yet — worth verifying before merge.

Original prompt

This section details on the original issue you should resolve

<issue_title>✨ Set up Copilot instructions</issue_title>
<issue_description>Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository.

</issue_description>

<agent_instructions>Hi Copilot, it has been a while since we updated the agent instructions for this repo. Please do so and make particular note of the following:

  • This project is based on the F Prime flight software framework from JPL and particularly uses the F Prime Zephyr ROTS support package to deploy to an RP2350 based microcontroller system
  • We use a makefile for most of the development environment management and macros for building, running the linter, etc.
  • Documentation of the tools that have been added to this repo can be valuable! </agent_instructions>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: Mikefly123 <61564344+Mikefly123@users.noreply.github.com>
Copilot AI changed the title [WIP] Update Copilot instructions for repository docs: Update Copilot agent instructions to reflect current project state Feb 27, 2026
@ineskhou ineskhou moved this to In progress in V1.X.X Mar 2, 2026
@Mikefly123 Mikefly123 marked this pull request as ready for review March 6, 2026 08:30
@Mikefly123 Mikefly123 requested a review from hrfarmer March 6, 2026 08:31
hrfarmer
hrfarmer previously approved these changes Mar 9, 2026
Copy link
Copy Markdown
Collaborator

@hrfarmer hrfarmer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think in its current state it's fine, however @Mikefly123 I want to know your thoughts on cutting out any information that's not necessary for the agent to have when developing code. (like for example, most of the descriptions of the makefile commands). I don't see many cases where the agent would need to know about them for the purpose of generating code. (Main concern I'm raising here being context bloat and the AI getting confused by things in the context it doesn't need to know about for its current task)

I guess I could also see the information potentially being useful for users new to the codebase being able to ask for context about certain components/features. Just wanna know your thoughts

@Mikefly123 Mikefly123 merged commit a718e96 into main Apr 1, 2026
4 checks passed
@Mikefly123 Mikefly123 deleted the copilot/update-copilot-instructions branch April 1, 2026 05:44
@github-project-automation github-project-automation bot moved this from In progress to Done in V1.X.X Apr 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

✨ Set up Copilot instructions

4 participants