Skip to content

Agent instructions#238

Open
tameware wants to merge 6 commits into
dds-bridge:developfrom
tameware:agent-instructions
Open

Agent instructions#238
tameware wants to merge 6 commits into
dds-bridge:developfrom
tameware:agent-instructions

Conversation

@tameware

Copy link
Copy Markdown
Collaborator
  1. Use snake_case for C and C++ code.
  2. Follow TTD.

tameware and others added 2 commits July 17, 2026 17:52
Document snake_case conventions for C and C++ so coding agents follow the modernized style.

Co-authored-by: Cursor <cursoragent@cursor.com>
Capture the red-green-refactor requirements so coding agents apply the same test-first discipline used in this repository.

Co-authored-by: Cursor <cursoragent@cursor.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds an AGENTS.md document to guide contributors/agents on naming and test-driven development expectations for DDS changes.

Changes:

  • Introduces naming guidance for C/C++ identifiers (favoring snake_case, with exceptions for legacy/public APIs).
  • Documents a strict red-green-refactor TDD workflow and test structuring expectations (AAA, edge cases).

Comment thread AGENTS.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

AGENTS.md:3

  • The naming guidance here is incomplete compared to the repo’s established C++ naming rules (e.g., constants use PascalCase and macros use ALL_CAPS). Since this file is meant to guide agents/contributors, it should either include those rules or explicitly defer to .github/instructions/cpp.instructions.md to avoid inconsistent naming for new code.
For C and C++ code, use snake_case for functions, methods, variables, and parameters. For C++ types use PascalCase, and for member variables use snake_case with a trailing underscore.

tameware and others added 2 commits July 17, 2026 21:18
Defer general and naming guidance to .github/instructions/cpp.instructions.md so agent and Copilot docs stay aligned.

Co-authored-by: Cursor <cursoragent@cursor.com>
Resolve AGENTS.md by keeping the pointer to shared C++ instructions, which already cover the naming details from the remote fix.

Co-authored-by: Cursor <cursoragent@cursor.com>
@zzcgumn

zzcgumn commented Jul 18, 2026

Copy link
Copy Markdown
Collaborator

I have started work to create a set of specifications to help coding agents. I suggest we add a project AGENTS.md file either as part of this upcoming pull request or in a later one. Our .github/copilot-instructions.md file does also need to be updated.

@tameware
tameware marked this pull request as ready for review July 18, 2026 14:06
@tameware

Copy link
Copy Markdown
Collaborator Author

I forgot that this was still a draft. I've promoted it. I'll merge it now with your approval, @zzcgumn - we can add your stuff to it when you're ready. I needed this because I found that Cursor was ignoring .github/copilot-instructions.md.

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.

3 participants