Skip to content

Refactor README and add AGENTS.md generation support#4

Merged
wcgomes merged 2 commits intomainfrom
agentsmd
Mar 22, 2026
Merged

Refactor README and add AGENTS.md generation support#4
wcgomes merged 2 commits intomainfrom
agentsmd

Conversation

@wcgomes
Copy link
Copy Markdown
Owner

@wcgomes wcgomes commented Mar 22, 2026

This pull request adds a new feature to the agency-agents dev container Feature: the ability to automatically fetch and overwrite an AGENTS.md file from the upstream AGENT-ZERO project into the workspace when the container is created. It introduces a new boolean option, create-agentsmd, and updates documentation, install logic, and test coverage to support this. The version is bumped to 0.2.0 to reflect this enhancement.

New Feature: AGENTS.md Sync Option

  • Added a new boolean option create-agentsmd to the agency-agents Feature. When enabled, it downloads AGENTS.md from the AGENT-ZERO repository and writes it to the workspace root during container creation, always overwriting any existing file. [1] [2] [3] [4] [5] [6] [7] [8] [9]

Documentation Updates

  • Updated README.md and src/agency-agents/README.md to document the new create-agentsmd option, its behavior, usage examples, and credits to upstream projects. [1] [2] [3] [4] [5] [6]

Install and Marker Logic Changes

  • Updated the install script to handle the new option, manage marker files, and ensure the on-create helper script is copied and executable. Marker files now include the create-agentsmd state to ensure correct re-installation when options change. [1] [2]

Test Enhancements

  • Added new tests for the create-agentsmd option, including checks for marker files, script presence, and successful overwriting of AGENTS.md. Updated existing tests to use the new marker file versioning scheme. [1] [2] [3] [4] [5] [6]

Version Bump

  • Bumped the Feature version to 0.2.0 to reflect the addition of the new option and related changes.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds an optional create-agentsmd capability to the agency-agents dev container Feature to sync an upstream AGENTS.md into the workspace at container creation time, along with supporting docs, install logic, and tests.

Changes:

  • Introduces create-agentsmd option and an onCreateCommand helper script to fetch/overwrite AGENTS.md.
  • Updates install marker scheme (v3) and adds marker/state handling for the new option.
  • Expands test scenarios and updates docs/README content; bumps Feature version to 0.2.0.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
src/agency-agents/devcontainer-feature.json Adds create-agentsmd option, bumps version, wires onCreateCommand.
src/agency-agents/install.sh Validates new option, updates marker naming, installs on-create helper and enable marker.
src/agency-agents/on-create.sh Implements AGENTS.md download/overwrite behavior gated by marker file.
src/agency-agents/README.md Documents the new option and adds credits note.
README.md Refactors repo-level README and documents create-agentsmd usage/options.
test/agency-agents/scenarios.json Adds scenario coverage for create-agentsmd=true.
test/agency-agents/*.sh Updates marker expectations to v3; adds a new scenario test for on-create behavior.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@wcgomes wcgomes merged commit 35b486c into main Mar 22, 2026
13 checks passed
@wcgomes wcgomes deleted the agentsmd branch March 22, 2026 06:51
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