Skip to content

Add Conventions and Agent Instructions documentations - #90

Merged
xlamorlette-datadog merged 8 commits into
mainfrom
xlamorlette/conventions-and-agents
Aug 20, 2026
Merged

xlamorlette-datadog merged 8 commits into
mainfrom
xlamorlette/conventions-and-agents

Conversation

@xlamorlette-datadog

@xlamorlette-datadog xlamorlette-datadog commented Aug 17, 2026 •

Copy link
Copy Markdown
Collaborator

This PR:

  • adds a 'Conventions' documentation;
  • adds an 'Agent Instructions' file;
  • merges the building instructions from the 'Claude Instructions' file in the 'Contributing' documentation;
  • amends the 'Readme' and 'Security' documentations.

This was done taking as an example what was recently done in dd-trace-cpp: Readme, Security, Contributing, Conventions, Claude, Agents.

Jira ticket: IDML-772 [Apache] Add conventions and agents documentation

@xlamorlette-datadog
xlamorlette-datadog marked this pull request as ready for review August 18, 2026 07:47
@xlamorlette-datadog
xlamorlette-datadog requested a review from a team as a code owner August 18, 2026 07:47
@xlamorlette-datadog
xlamorlette-datadog requested review from Anilm3 and removed request for a team August 18, 2026 07:47
@datadog-datadog-prod-us1-2

datadog-datadog-prod-us1-2 Bot commented Aug 18, 2026 •

Copy link
Copy Markdown

🎯 Code Coverage (details)
• Patch Coverage: 100.00%
• Overall Coverage: 51.08% (+0.00%)

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 7deae76 | Docs | View more details | Give us feedback!

@xlamorlette-datadog xlamorlette-datadog changed the title Little reformating in Main, Security and Contributing documentations Add Conventions and Agent Instructions documentations Aug 18, 2026
Comment thread doc/conventions.md
- Keep functions small and focused (<~ 20 lines when practical).
- When practical, place caller functions before callees, so the code can be read from top to bottom.

## C++ Code Style

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.

If these could be expressed in clang-format and clang-tidy. Then lets do it that way.

LLMs are awesome, but detereministic rules are even better :D

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

For sure!
I think doing so should be done in a dedicated PR, because it could imply correcting existing code.

Comment thread CLAUDE.md Outdated

@pawelchcki pawelchcki 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.

One suggestion about using clang-tidy and format. Instead of relying on LLMs promise to follow the rules :D

Other than this looks good to me the

@pawelchcki

Copy link
Copy Markdown
Contributor

I think its worth keeping in mind that AGENT.md rules - with newer LLMs might need trimming.
BUt these rules are not overperscriptive so I think they're good .

@xlamorlette-datadog
xlamorlette-datadog merged commit 2ae80c1 into main Aug 20, 2026
15 checks passed
@xlamorlette-datadog
xlamorlette-datadog deleted the xlamorlette/conventions-and-agents branch August 20, 2026 09:40
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.

2 participants