Skip to content

Update copilot instructions to reflect current repository state (ESPTOOL-1270)#43

Merged
dobairoland merged 1 commit intomasterfrom
copilot/update-instruction-file
Feb 11, 2026
Merged

Update copilot instructions to reflect current repository state (ESPTOOL-1270)#43
dobairoland merged 1 commit intomasterfrom
copilot/update-instruction-file

Conversation

Copy link
Contributor

Copilot AI commented Feb 10, 2026

Update Copilot Instructions to Reflect Current Repository State

Analysis Completed ✅

  • Read current .github/copilot-instructions.md file (382 lines → 388 lines → 384 lines → 391 lines)
  • Analyzed repository structure, workflows, and build configuration
  • Identified and fixed all discrepancies between instruction file and current state
  • Cross-verified with README.md, workflows, and actual source files

All Issues Fixed ✅

  • Chip count mismatch: Updated from "11 chips" to "12 chips" with note about 14 defined in cmake
  • Updated chip lists: Added esp32h21, esp32h4, esp32p4-rev1 to all relevant chip lists throughout file
  • TODO locations updated: Fixed line numbers for command_handler.c (now 213, 218, 300, 563, 905) and transport.c (now 58)
  • miniz.c/h removed: Removed all references to non-existent miniz files (2 mentions removed per review feedback)
  • Source file count: Updated from "~20 C source files" to "~8 C source files" (accurate count)
  • Line count: Updated from "~1000 lines" to "~1600 lines" (verified with wc -l)
  • Build time clarification: Added note about 12 chips built vs 14 defined in cmake
  • Build time measurements: Updated from "~5-10 seconds per chip, ~2-3 minutes total" to "~0.5-1.5 seconds per chip, ~10-15 seconds total" based on actual measurements
  • Copyright years: Updated examples from 2025 to 2025-2026 with note about auto-management by check-copyright tool
  • Linker scripts detail: Clarified 12 chip-specific scripts + 1 common.ld
  • install_all_chips.sh: Added proper description (copies JSONs to esptool, requires ESPTOOL_STUBS_DIR env var)
  • Unittest structure: Added detail about target tests, scripts directory, and load-test.py
  • Documentation maintenance: Added validation step reminding developers to keep copilot-instructions.md and README.md up-to-date

Verification Completed ✅

  • Verified all chip counts match build_all_chips.sh (12 chips: esp32, esp32c2, esp32c3, esp32c5, esp32c6, esp32c61, esp32h2, esp32p4-rev1, esp32p4, esp32s2, esp32s3, esp8266)
  • Verified cmake defines 14 total chips (includes esp32h21, esp32h4 not in build script)
  • Confirmed TODO line numbers are accurate in current source files
  • Confirmed miniz.c/h files don't exist in src/
  • Confirmed source file count is accurate (8 C files: main.c, slip.c/h, command_handler.c/h, transport.c/h, commands.h)
  • Verified workflows match descriptions (build_and_release.yml, host_tests.yml, dangerjs.yml, jira.yml)
  • Verified Python version consistency (3.13 in workflows and pyproject.toml)
  • Cross-checked with README.md for consistency
  • Verified all file paths and directory structures mentioned are accurate
  • Measured actual build times: 0.5-1.5s per chip, 10-15s total for 12 chips

Review Feedback Addressed ✅

  • Removed all mentions of miniz from the document (lines 159 and 338)
  • Added new validation step (feat: Adopt cmake for project build system generation #5) for keeping documentation files up-to-date with PRs
  • Re-measured build times and updated all references (was 5-10s per chip, now 0.5-1.5s; was 2-3 min total, now 10-15s)

Summary of Changes

  • Total changes: 35 insertions, 26 deletions across all updates
  • File size: 382 → 388 → 384 → 391 lines (final)
  • All factual information now matches current repository state (as of Feb 11, 2026)
  • Build time measurements verified with actual builds
  • Instructions now include guidance for maintaining themselves and README.md
  • Instructions are ready to guide developers working with this codebase
Original prompt

There has been significant changes in this repository since the copilot instruction MD file has been generated. Review the whole repository and see if the instruction file needs any updates.


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

Copilot AI changed the title [WIP] Review and update copilot instruction file Update copilot instructions to reflect current repository state Feb 10, 2026
Copilot AI requested a review from dobairoland February 10, 2026 10:16
@github-actions github-actions bot changed the title Update copilot instructions to reflect current repository state Update copilot instructions to reflect current repository state (ESPTOOL-1270) Feb 10, 2026
Copilot AI requested a review from dobairoland February 10, 2026 10:44
@dobairoland dobairoland marked this pull request as ready for review February 10, 2026 10:46
@dobairoland dobairoland requested review from Dzarda7 and radimkarnis and removed request for dobairoland February 10, 2026 10:46
@github-actions
Copy link

github-actions bot commented Feb 10, 2026

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello Copilot, we appreciate your contribution to this project!


Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against 179d347

@dobairoland
Copy link
Collaborator

@copilot Please add further instructions into .github/copilot-instructions.md.

  • If the reviewed PR adds or removes files then the file lists present in .github/copilot-instructions.md needs to updated.
  • If a new chip support is added then the list of chip targets in .github/copilot-instructions.md needs to be updated.
  • In general, each PR review should include a check whether .github/copilot-instructions.md or README.md is up-to-date.

Copy link
Contributor Author

Copilot AI commented Feb 10, 2026

@copilot Please add further instructions into .github/copilot-instructions.md.

  • If the reviewed PR adds or removes files then the file lists present in .github/copilot-instructions.md needs to...

Added new validation step #5 in the "Validation Steps Before PR Submission" section that covers:

  • Updating file lists when files are added/removed
  • Updating chip target lists when new chip support is added
  • General review of both copilot-instructions.md and README.md for accuracy

(465cf67)

@dobairoland dobairoland force-pushed the copilot/update-instruction-file branch from 465cf67 to 93c2417 Compare February 10, 2026 14:42
@Dzarda7
Copy link
Collaborator

Dzarda7 commented Feb 11, 2026

LGTM, thanks, yes, we should update this file more regularly.

Copy link
Member

@radimkarnis radimkarnis left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

Copy link
Contributor Author

Copilot AI commented Feb 11, 2026

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • dl.espressif.com
    • Triggering command: /usr/bin/wget wget REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

@dobairoland dobairoland force-pushed the copilot/update-instruction-file branch from 1c42935 to 179d347 Compare February 11, 2026 14:29
@dobairoland
Copy link
Collaborator

Thank you guys for the review!

@dobairoland dobairoland merged commit 8118618 into master Feb 11, 2026
7 checks passed
@dobairoland dobairoland deleted the copilot/update-instruction-file branch February 11, 2026 14:34
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.

4 participants