Update instruction files#1456
Merged
pstroffolino merged 9 commits intoMay 22, 2026
Merged
Conversation
jfagunde
reviewed
May 15, 2026
DomSyna
approved these changes
May 19, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s Copilot/agent instruction documents to more explicitly describe AAMP’s C++11 legacy context, set C++17 as the modernization target, and expand guidance around ownership, documentation style, naming, and logging.
Changes:
- Clarifies that the current codebase is predominantly C++11 while new work should target C++17.
- Expands C++ guidance with additional ownership rules, documentation examples, and printf format guidance.
- Adds AAMP-specific conventions for file naming, include guards, and logging macro usage.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
.github/instructions/legacy-cpp-patterns.instructions.md |
Adds explicit context on C++11 legacy and C++17 modernization target. |
.github/instructions/cpp.instructions.md |
Expands C++17 guidance, ownership rules, Doxygen rules/examples, and printf format reference. |
.github/instructions/aamp.instructions.md |
Adds conventions for naming, include guards, and logging guidance; updates language baseline statement. |
.github/copilot-instructions.md |
Updates global Copilot formatting + documentation guidance and reiterates C++11→C++17 modernization direction. |
Replace the flat ban on ///< with a two-style model: - /** ... */ for API-level docs (classes, functions, macros, file headers) - ///< trailing comments for member docs (struct fields, enum values) Adds 10 core principles covering: document meaning not type, adjacency, conciseness, non-obvious constraints, grouping, avoiding redundancy, consistency, relevance, and sync with code. Updates Doxygen Style Guide intro and corrects Data Member and Enum examples to use ///< instead of the now-discouraged /**< */
The two documentation bullets were a stale copy of the old section 3 rules and contradicted the reworked guidance. Replace with a single pointer to instructions/cpp.instructions.md (section 3) which is now the authoritative source.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Full detail on method in ticket, including derived coding guidelines.