Skip to content

add AGENTS.md with repository-specific guidance for coding agents#3690

Open
aero-oli wants to merge 1 commit into
ArduPilot:masterfrom
aero-oli:add-agents-md
Open

add AGENTS.md with repository-specific guidance for coding agents#3690
aero-oli wants to merge 1 commit into
ArduPilot:masterfrom
aero-oli:add-agents-md

Conversation

@aero-oli
Copy link
Copy Markdown

Summary

Add a root AGENTS.md with repository-specific guidance for coding agents and AI-assisted contributors working in the Mission Planner repo.

Why

Mission Planner has a few repo-specific constraints that are easy for agents to get wrong: it is primarily a Windows/Visual Studio codebase, it uses submodules, the recommended build target for normal work is the MissionPlanner project, and there are two different plugin models (Plugins/ projects vs lowercase plugins/ runtime .cs scripts). A focused AGENTS.md should help agent-authored PRs stay smaller, safer, and easier to review.

What this adds

  • setup/build guidance aligned with the existing README/dev docs
  • a concise map of the main repo areas
  • explicit guidance to prefer small, surgical diffs
  • clearer expectations around validation and PR summaries
  • repo-specific cautions for:
    • WinForms/UI changes
    • MAVLink / CurrentState / units / fallback logic
    • shared code in ExtLibs/
    • the distinction between compiled plugins and runtime plugin scripts

Impact

Documentation only.

This does not change runtime behavior, build outputs, packaging, dependencies, or release artifacts.

Validation

Drafted from a review of:

  • the current repo README/build instructions
  • the Mission Planner developer build page
  • recent merged/open PR title/body patterns
  • public forum guidance around Mission Planner plugins

The file is intended to improve the quality and mergeability of future agent-authored changes, not to replace maintainer judgement.

Added repository-specific instructions for agents working in ArduPilot/MissionPlanner, covering scope, environment, build validation, repository structure, plugin distinctions, and change discipline.
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.

1 participant