Skip to content

docs: add SETUP.MD for Agentic Inner Loop KPI#352

Open
giuliastf wants to merge 1 commit into
mainfrom
docs/add-setup-md
Open

docs: add SETUP.MD for Agentic Inner Loop KPI#352
giuliastf wants to merge 1 commit into
mainfrom
docs/add-setup-md

Conversation

@giuliastf
Copy link
Copy Markdown
Collaborator

@giuliastf giuliastf commented Jun 4, 2026

Copilot AI review requested due to automatic review settings June 4, 2026 14:48
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 a repository-level setup guide intended to support the “Agentic Inner Loop KPI” workflow by documenting prerequisites and the standard local commands to install deps, verify imports, build, and run tests across the monorepo packages.

Changes:

  • Add SETUP.MD with prerequisites, platform target notes, and environment variable expectations.
  • Document uv-based install/sync, verification, build, and test commands for each package.
  • Include a “Sample Code Change” recipe plus a targeted verification command for KPI validation.

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

Comment thread SETUP.MD Outdated
Comment on lines +29 to +31
# Install uv if not present
curl -LsSf https://astral.sh/uv/install.sh | sh
export PATH="$HOME/.local/bin:$PATH"
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Addressed in latest commit (force-pushed) — switched to python3 -m pip install --upgrade uv (matches CONTRIBUTING.md style, no remote shell execution).

Comment thread SETUP.MD
- Python 3.11+
- [uv](https://docs.astral.sh/uv/) 0.5+

### Supported platforms
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

The ### Supported platforms heading is mandated verbatim by the Agentic Inner Loop SETUP.md spec — the validation pipeline parses for that exact section title. Renaming risks setup-file-malformed. The clarifying paragraph below already scopes it to the KPI target.

Adds the SETUP.MD required by the Agentic Inner Loop validation
pipeline (MER KPI 11). Documents prerequisites, environment setup,
build, test, and a prescribed sample code change so an AI agent
can autonomously run the inner dev loop on a clean Linux machine.

PRODEV-624
@giuliastf giuliastf force-pushed the docs/add-setup-md branch from 06b7849 to e646759 Compare June 5, 2026 08:22
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Jun 5, 2026

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