Skip to content

Add repository guidance for coding agents#18

Merged
schaubh merged 1 commit into
developfrom
feature/add_agents_file
Jul 9, 2026
Merged

Add repository guidance for coding agents#18
schaubh merged 1 commit into
developfrom
feature/add_agents_file

Conversation

@schaubh

@schaubh schaubh commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add a root-level AGENTS.md describing the BSK-SDK architecture and public plugin contract.
  • Document branch and PR expectations, generated/vendored boundaries, and supported build and test workflows.
  • Capture lessons from previous changes around SWIG runtime compatibility, CMake scope, generated message bindings, version checks, and downstream plugin testing.
  • Add a focused checklist for future branch and PR reviews.

Motivation

BSK-SDK has several integration points where a locally successful change can
still break installed wheels or downstream plugins. This guidance consolidates
the repository-specific knowledge needed to make and review changes safely,
especially around Basilisk synchronization, CMake/SWIG behavior, and the
custom-atm-plugin compatibility example.

Impact

Documentation and contributor guidance only. There are no runtime, packaging,
CMake, dependency, or downstream API changes.

The Basilisk submodule remains unchanged at v2.11.0.

Verification

Not run because this is a documentation-only change. The branch contains only
the new AGENTS.md file.

@schaubh schaubh self-assigned this Jul 9, 2026
@schaubh schaubh added the documentation Improvements or additions to documentation label Jul 9, 2026
@schaubh schaubh added this to Basilisk Jul 9, 2026
schaubh added a commit that referenced this pull request Jul 9, 2026
@schaubh schaubh force-pushed the feature/add_agents_file branch from 614dd28 to 2c78e36 Compare July 9, 2026 19:38

@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: 614dd28434

ℹ️ 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 AGENTS.md
@schaubh schaubh moved this to 👀 In review in Basilisk Jul 9, 2026
@schaubh schaubh force-pushed the feature/add_agents_file branch from 2c78e36 to 8b43a0d Compare July 9, 2026 19:48
@schaubh schaubh merged commit a622e9b into develop Jul 9, 2026
18 checks passed
@schaubh schaubh deleted the feature/add_agents_file branch July 9, 2026 20:06
@github-project-automation github-project-automation Bot moved this from 👀 In review to ✅ Done in Basilisk Jul 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

1 participant