Skip to content

Common coding conventions for the project - #3997

Merged
satween merged 2 commits into
developfrom
tvaleev/feature/sdk-skills
Oct 21, 2026
Merged

satween merged 2 commits into
developfrom
tvaleev/feature/sdk-skills

Conversation

@satween

@satween satween commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

What does this PR do?

Adds shared skills for coding agents (sources in ai/skills/, symlinked into .claude/skills/ and .agents/skills/):

  • /sdk-tests — unit test conventions.
  • /sdk-commit — commit message conventions.
  • /sdk-pr-prepare — checks before opening a PR: compile, tests, lint (Gradle tasks only), regeneration of checked-in generated files, then validation with checkGeneratedFiles.
  • /sdk-pr-stack create|update — create and update stacked PRs with Graphite.
  • /sdk-review — code review focused on SDK-specific risks (binary compatibility, threading, main-thread blocking), run in parallel with the agent's built-in review.

Updates AGENTS.md:

  • New "Agent Skills" section that points to the skill for each task.
  • Threading: declare AtomicXXX fields as val.
  • Testing: a single-expression test may use one // When / Then marker.
  • Removed references to local_ci.sh: everything is available through Gradle tasks.

Motivation

Help coding agents follow our project conventions consistently.

Additional Notes

All skill names start with sdk- to:

  • Avoid name collisions with existing skills.
  • Make them easy to filter in the agent interface.
  • Make new project skills easy to discover as the project grows.

Review checklist (to be filled by reviewers)

  • Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
  • Make sure you discussed the feature or bugfix with the maintaining team in an Issue
  • Make sure each commit and the PR mention the Issue number (cf the CONTRIBUTING doc)

🤖 Generated with Claude Code

@satween
satween marked this pull request as ready for review October 16, 2026 13:47
@satween
satween requested review from a team as code owners October 16, 2026 13:47
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review 🔄 Running since 2026-10-21T13:30:37.395639Z 401e770 New commits
🔒 Security Review ✅ Completed 2026-10-21T13:38:04.849550Z 401e770 New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@datadog-datadog-prod-us1

datadog-datadog-prod-us1 Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Tests

🎉 All green!

🧪 All tests passed
❄️ No new flaky tests detected

🔄 Datadog retried 2 tests - 2 passed on retry View in Datadog

🎯 Code Coverage (details)
• Patch Coverage: 100.00%
• Overall Coverage: 71.80% (+0.01%)

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

@datadog-datadog-prod-us1 datadog-datadog-prod-us1 Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Bits Code Review: FAIL

The stack-reconstruction workflow can commit reversals of newer upstream changes. Additional instruction errors can block PR creation and API preparation or leave intended reliability suites untested.

Open Bits AI session

🤖 Bits Code Review · Commit 3d8acca

Comment thread ai/skills/sdk-pr-stack/references/create.md Outdated
Comment thread ai/skills/sdk-pr-prepare/SKILL.md Outdated
Comment thread ai/skills/sdk-pr-prepare/SKILL.md Outdated
Comment thread ai/skills/sdk-pr-prepare/SKILL.md Outdated
Comment thread ai/skills/sdk-commit/SKILL.md Outdated
Comment thread ai/skills/sdk-code/SKILL.md Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 3d8accaff0

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread ai/skills/sdk-review/SKILL.md
Comment thread ai/skills/sdk-pr-prepare/SKILL.md Outdated
Comment thread ai/skills/sdk-code/SKILL.md Outdated
Comment thread ai/skills/sdk-pr-prepare/SKILL.md Outdated
Comment thread ai/skills/sdk-review/SKILL.md
Comment thread ai/skills/dd-revirew/SKILL.md Outdated
Comment thread ai/skills/dd-pr-prepare/SKILL.md Outdated
Comment thread ai/skills/sdk-pr-prepare/SKILL.md Outdated
Comment thread ai/skills/sdk-tests/SKILL.md Outdated
Comment thread ai/skills/sdk-revirew/SKILL.md Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e32a9bcc86

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread ai/skills/sdk-pr-stack/references/create.md Outdated
Comment thread ai/skills/sdk-pr-prepare/SKILL.md Outdated
Comment thread ai/skills/sdk-pr-stack/references/create.md Outdated
Comment thread ai/skills/sdk-pr-stack/references/create.md Outdated
Comment thread ai/skills/sdk-pr-prepare/SKILL.md
Comment thread ai/skills/sdk-pr-stack/references/create.md
Comment thread .claude/skills/sdk-revirew Outdated
Comment thread .agents/skills/sdk-revirew Outdated
Comment thread ai/skills/sdk-code/SKILL.md Outdated
Comment thread ai/skills/sdk-code/SKILL.md Outdated
Comment thread ai/skills/sdk-code/SKILL.md Outdated
Comment thread ai/skills/sdk-tests/SKILL.md Outdated
Comment thread ai/skills/sdk-tests/SKILL.md
Comment thread ai/skills/sdk-tests/SKILL.md Outdated
Comment thread ai/skills/sdk-tests/SKILL.md Outdated
Comment thread ai/skills/sdk-tests/SKILL.md Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 91cc7f3e73

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread ai/skills/sdk-pr-prepare/SKILL.md Outdated
Comment thread ai/skills/sdk-pr-prepare/SKILL.md
Comment thread ai/skills/sdk-pr-stack/references/create.md Outdated
Comment thread ai/skills/sdk-review/SKILL.md Outdated
Comment thread ai/skills/sdk-pr-stack/references/update.md
@satween satween added the ready-for-human-review All agentic review feedback was addressed and PR is ready for the human review. label Oct 20, 2026
@0xnm 0xnm mentioned this pull request Oct 21, 2026
3 tasks
Run tool and build-logic tests and format before parallel checks in
sdk-pr-prepare, default the stack base to develop, guard update against
branches held by other worktrees, and include untracked files in reviews.
Run:

```bash
gt restack

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

why not using the gh stack instead ?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I found graphite a bit more stable a the moment of writing this skill, maybe we could migrate to the gh stack later

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I am using gh stack with no problems and it is very well integrated in Github dashboard

Comment on lines +337 to +349
### 3.3 Compile-check configuration

Detect build systems in the repo root (use `Glob`/`Read`):

| Manifest file | Default command |
|-----------------------|--------------------------|
| `package.json` | `npm run build` |
| `go.mod` | `go build ./...` |
| `Cargo.toml` | `cargo build` |
| `pom.xml` | `mvn -q compile` |
| `build.gradle(.kts)` | `./gradlew assembleLibrariesDebug` |
| `pyproject.toml` | `python -m compileall .` |
| (none, only `.py`) | `python -m compileall .` |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

that seems redundant tbh, we don't have all this


## Naming convention

**Do not use `region` comments in tests.**

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

sometimes they are useful though

@satween
satween merged commit e72f2a9 into develop Oct 21, 2026
27 checks passed
@satween
satween deleted the tvaleev/feature/sdk-skills branch October 21, 2026 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-for-human-review All agentic review feedback was addressed and PR is ready for the human review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants