Add Coding Standards and AI Tool Advice.#185
Open
zzcgumn wants to merge 8 commits into
Open
Conversation
…tories Bazel constructs a minimal PATH that excludes Homebrew on macOS, causing the doxygen availability check to fail even when doxygen is installed. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds project documentation describing DDS coding standards and practical guidance for using coding agents/tools, while also tidying GitHub/Git workflow instructions and improving the Bazel Doxygen doc generation rule’s PATH handling.
Changes:
- Add
docs/coding_standards_and_ai_advice.mdwith coding standards links and tooling recommendations. - Update the
//:doxygen_docsgenrule to adjust PATH based on host OS before invokingdoxygen/zip. - Simplify GitHub/Git workflow instructions to prefer CLI-based workflows over MCP-specific guidance.
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| MODULE.bazel.lock | Updates Bazel module lock digest for Emscripten deps. |
| docs/coding_standards_and_ai_advice.md | New documentation on coding standards + AI/tooling guidance; includes docs build instructions. |
| BUILD.bazel | Improves doxygen_docs genrule robustness by setting PATH per OS. |
| .github/instructions/github.instructions.md | Removes MCP-server-specific guidance; updates contributor workflow tooling section. |
| .github/instructions/git.instructions.md | Updates PR-opening step to reference CLI workflow. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
tameware
reviewed
Jun 13, 2026
| @@ -32,25 +31,14 @@ You have access to an MCP server named **`github`** (running `mcp-github`) which | |||
| 5. Small PRs are preferred — keep them focused on one logical change. | |||
Contributor
There was a problem hiding this comment.
This is OK. Slightly better: "…keep each focused…"
| - `Merge PR #45 after approval` | ||
|
|
||
| ## Automation | ||
| - CI/CD runs automatically for all PRs. |
| cmd = """ | ||
| set -e | ||
| case "$$(uname -s)" in | ||
| Darwin) PATH="/opt/homebrew/bin:/usr/local/bin:$$PATH" ;; |
Contributor
There was a problem hiding this comment.
Is homebrew an official tool for dds' macOS builds? If so, we should document that. I certainly use it.
Contributor
There was a problem hiding this comment.
Consider mentioning somewhere that this file is intentionally included in the repo, per current bazel best practices.
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.
Adds a document about coding standards and AI tools. It is based on my experience from modernising the code base in the first quarter of 2026. I have also tidied up GitHub instructions, which define the coding standards and fixed the command to extract the documentation from Doxygen style comments.