Add AGENTS.md with validated repo onboarding guidance#2522
Open
Copilot wants to merge 3 commits into
Open
Conversation
|
Copilot is not a collaborator of the repo |
Agent-Logs-Url: https://github.com/canonical/canonical.com/sessions/f00387c8-57b9-4b2b-9795-895305ed9ee6 Co-authored-by: muhammad-ali-pk <60434613+muhammad-ali-pk@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add AGENTS.md to improve coding agent onboarding
Add AGENTS.md with validated repo onboarding guidance
May 12, 2026
Contributor
muhammad-ali-pk
left a comment
muhammad-ali-pk
left a comment
There was a problem hiding this comment.
@copilot Please address my feedback.
Agent-Logs-Url: https://github.com/canonical/canonical.com/sessions/ff8aa617-3059-4d2e-a87f-20e12ca73fd9 Co-authored-by: muhammad-ali-pk <60434613+muhammad-ali-pk@users.noreply.github.com>
Author
anthonydillon
requested changes
May 12, 2026
Contributor
anthonydillon
left a comment
anthonydillon
left a comment
There was a problem hiding this comment.
Some comments in the code
| On a fresh clone, this was the most reliable full-stack path: | ||
|
|
||
| ```bash | ||
| yarn install --immutable |
Contributor
There was a problem hiding this comment.
Is this required locally?
Comment on lines
+54
to
+60
| SECRET_KEY=insecure_test_key \ | ||
| APPLICATION_CRYPTO_SECRET_KEY=insecure_test_key \ | ||
| SERVICE_ACCOUNT_EMAIL=test_email@email.com \ | ||
| SERVICE_ACCOUNT_PRIVATE_KEY=test_private_key \ | ||
| HARVEST_API_KEY=local_development_fake_key \ | ||
| RECAPTCHA_SITE_KEY=test \ | ||
| PORT=8002 \ |
Contributor
There was a problem hiding this comment.
These should be set in the .env.local file
Comment on lines
+52
to
+53
| dotrun install | ||
| dotrun build |
Contributor
There was a problem hiding this comment.
These are not required
Comment on lines
+65
to
+66
| - The first `dotrun` command may take longer than expected because it checks/pulls the dotrun image and creates `.venv`. | ||
| - Always run `dotrun install` before the first `dotrun build`/`dotrun` in a fresh clone. |
|
|
||
| ### Docker helper | ||
|
|
||
| - `./run --help` works and documents the old Docker workflow. |
| ### LLM-related work | ||
|
|
||
| - This repo does not contain a checked-in LLM provider/runtime configuration for application features. | ||
| - If you add any new LLM configuration, prefer GitHub Models unless the task explicitly requires something else. |
Comment on lines
+195
to
+201
| SECRET_KEY=insecure_test_key | ||
| HARVEST_API_KEY=local_development_fake_key | ||
| APPLICATION_CRYPTO_SECRET_KEY=insecure_test_key | ||
| SERVICE_ACCOUNT_EMAIL=test_email@email.com | ||
| SERVICE_ACCOUNT_PRIVATE_KEY=test_private_key | ||
| RECAPTCHA_SITE_KEY=test | ||
| PORT=8002 |
Contributor
There was a problem hiding this comment.
This repeated several times and incorrectly
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds a repository-specific
AGENTS.mdto onboard coding agents tocanonical/canonical.comwith less exploration and fewer setup/CI missteps. The guide consolidates where code lives, which commands matter, and which repository-level workflows and environment variables matter most.Done
Repository onboarding
AGENTS.mdat the repo root for first-time coding agentsValidated workflows
dotrun.github/workflows/pr.yamlOperational guidance
requirements.txtpython3 app.pydoes not start the sitedotrunis the preferred workflow for running the full site locally because it matches the README and CI expectationsQA
dotrunAGENTS.mdand confirm it covers:Issue / Card
Original issue: add
AGENTS.mdto onboard the repository for Copilot coding agent use.Screenshots
Not applicable.