Skip to content

AGENTS.md

Latest commit

 

History

History
74 lines (54 loc) · 2.6 KB

AGENTS.md

File metadata and controls

74 lines (54 loc) · 2.6 KB
Raw

Devcontainers

Devcontainer features for DuploCloud customer workspaces. Shell scripts in src/*/install.sh.

Structure

  • src/ - Devcontainer features (aws-cli, gcloud-cli, terraform, openvpn, onepassword-cli)
  • scripts/ - Helper scripts
  • test/ - Test files for features

Agents

  • @git - Git operations using GitKraken tools (status, commit, push, branch, etc.)
  • @debug - Debug GitHub Actions pipelines using gh CLI
  • @devcontainer - Devcontainer features expert (create, test, use features)

Prompts

  • new-feature - Guided workflow to create a new devcontainer feature

Agent Guidance

When troubleshooting or modifying this repo:

Topic See README Section
Devcontainer build failures / base image selection ## Devcontainer Base Image
Feature installation scripts ## Features
Project layout ## Project Structure

Testing Features

Run feature tests locally before committing:

# Test all features
devcontainer features test

# Test specific feature
devcontainer features test -f kubernetes

# Test only scenarios
devcontainer features test -f kubernetes --skip-autogenerated

Tests verify configuration, dependencies, and functionality across different feature options. See test/<feature-name>/scenarios.json for available test scenarios. For feature-specific notes, check NOTES.md in the repo root.

Documentation Policies

Context for feature level README.md files:

  • all src/*/README.md files are generated, don't edit these
  • use these for reading the full docs

Requirements and Policies for managing NOTES.md:

  • NOTES.md is ultimately appended to the bottom of the README.md
  • Github action injects NOTES.md into README.md
  • add your docs in src/*/NOTES.md files
  • when given a task, take notes and docs in the NOTES.md files
  • don't use # headings in NOTES.md, use ## and below
  • start directly with a new ## section to prevent floating text in the middle of README.md
  • include examples for the feature

When given URL's to read:

  • also called: links, references, external docs, urls, sources, uri
  • determine a Title for the link
  • use markdown format like [Title](http://link)
  • save to README.md
    • always save them as markdown references at the bottom of the main ./README.md file
    • save URLs under the ## References section
  • saving to NOTES.md
    • use the [Title](http://link) format in descriptions so they render as clickable links
    • do not create a ## References section in NOTES.md
    • just include the links inline in the text where relevant