Skip to content

Add AGENTS.md - #261

Merged
luisremis merged 2 commits into
mainfrom
add_agents_md
Jul 1, 2026
Merged

Add AGENTS.md#261
luisremis merged 2 commits into
mainfrom
add_agents_md

Conversation

@luisremis

@luisremis luisremis commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

This pull request adds a new AGENTS.md documentation file, providing clear instructions and architectural guidance for working with ApertureDB workflows in this repository. The documentation outlines the project structure, testing and build processes, and important conventions for contributors.

Documentation additions:

  • Added AGENTS.md to explain the repository's architecture, including the organization of workflow applications in apps/, use of a shared base Docker image, and the role of supporting services like aperturedb and lenz.
  • Provided step-by-step instructions for testing and building workflow applications using Docker Compose, including details on how test.sh orchestrates builds and tests, and where to find test logs.
  • Documented conventions and quirks, such as Docker Compose dependency sequencing, required environment variables for workflows, and code style expectations.

Copilot AI review requested due to automatic review settings July 1, 2026 18:17

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 AGENTS.md guide intended to help automated agents (and contributors) understand the repo’s Docker-based workflow architecture and the expected way to build/test apps.

Changes:

  • Introduces AGENTS.md describing repository layout (apps/, base/docker/) and Docker Compose–orchestrated testing.
  • Documents how apps/<workflow-name>/test.sh runs builds, seeds data, executes workflows, and runs pytest inside containers.
  • Captures practical conventions around service dependencies, env vars, and log locations.

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

Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 1, 2026 18:41

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

Comment thread AGENTS.md
Comment thread AGENTS.md
@luisremis
luisremis merged commit 05f96c2 into main Jul 1, 2026
23 checks passed
@luisremis
luisremis deleted the add_agents_md branch July 1, 2026 19:25
@luisremis

Copy link
Copy Markdown
Contributor Author

Docker images for version v2026.7.0 were built and pushed after this PR was merged. View workflow run

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