Skip to content

Add project guidance for agents and tests#1230

Merged
bengineerd merged 8 commits into
pre-releasefrom
agent-guidance
May 7, 2026
Merged

Add project guidance for agents and tests#1230
bengineerd merged 8 commits into
pre-releasefrom
agent-guidance

Conversation

@bengineerd

Copy link
Copy Markdown
Contributor

Description

Add repository-level guidance for human contributors and AI agents working on Rogue. This introduces AGENTS.md, a project-wide DEVELOPMENT.md, expanded test methodology documentation, and a standardized docs/plans/<task-name>/ location for substantial planning, progress, handoff, decision, and completion notes.

Details

  • Document the preferred Miniforge/rogue_build local build flow, CI expectations, C++/Python conventions, public API change checklist, documentation expectations, packaging notes, and PR guidance.
  • Add test methodology guidance for Python and native C++ tests, including marker/label selection and the policy against source-audit tests.
  • Remove old vestigial planning documents from docs/plans/ and replace them with a reusable work-plan policy.
  • Remove audit-style native C++ tests under tests/cpp/protocols/hardware/ and update C++ test documentation accordingly.

Validation: checked the edited Markdown files for tabs/trailing whitespace during the documentation updates. Ran a CMake configure with -DROGUE_BUILD_TESTS=ON and listed native C++ tests with ctest -N -L cpp after removing the audit-style C++ tests.

JIRA

None.

Related

None.

@bengineerd bengineerd marked this pull request as ready for review May 7, 2026 21:06
@bengineerd bengineerd requested a review from slacrherbst May 7, 2026 21:06
@bengineerd bengineerd merged commit f07660a into pre-release May 7, 2026
7 checks passed
@ruck314 ruck314 deleted the agent-guidance branch May 15, 2026 17:49
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