Skip to content

chore: forward-looking AGENTS.md, pinned ICP skills, contribution policy, dfx-era cleanup - #1465

Open
marc0olo wants to merge 1 commit into
masterfrom
chore/agents-md-skills-contribution-cleanup
Open

chore: forward-looking AGENTS.md, pinned ICP skills, contribution policy, dfx-era cleanup#1465
marc0olo wants to merge 1 commit into
masterfrom
chore/agents-md-skills-contribution-cleanup

Conversation

@marc0olo

Copy link
Copy Markdown
Member

The dfx→icp-cli migration is complete. This PR rewrites the repo's meta files around what matters going forward.

AGENTS.md (551 → ~230 lines)

  • Migration checklist and every "when migrating" instruction removed.
  • No version pins: snippets use vX.Y.Z placeholders; a Versions section says to take current versions from the most recently updated examples (the doc was already wrong — it showed @dfinity/asset-canister while all 40 frontends use @dfinity/static-site).
  • CI section corrected to the reusable _run-example.yml reality.
  • New conventions documented: environments are exactly local and ic (the ic name is the ICP Ninja deploy contract; never a default staging), canister: imports + --actor-env-alias for inter-canister calls, version-bump scope rule (ask repo-wide vs. single example — applies to recipes too), new-example acceptance criteria, docs-over-product link rule.

ICP skills (dfinity/icskills#251 ceremony)

  • Managed <!-- ic-skills:managed --> block in pinned, ask-to-update mode (copied verbatim from the ceremony).
  • skills-lock.json committed; .agents/skills gitignored — reinstall with npx skills experimental_install.
  • No hand-curated "skills relevant to this repo" table — relevance is decided per task.

Contribution policy

  • CONTRIBUTING.md rewritten: not accepting external PRs while examples are being restructured to integrate with the developer docs; bug reports via issues/forum remain welcome.
  • ADDING_AN_EXAMPLE.md deleted; its acceptance criteria (educational focus, docs home, DX-team maintenance, both languages) folded into AGENTS.md.

Dead machinery removed

  • .ic-commit + update-ic-commit.yml (weekly bot PRs updating dfx-cache artifacts — last used 2024-08) and the five orphaned provision/cache scripts; CI runs in icp-dev-env containers.
  • .gitmodules — referenced a submodule under the long-deleted archive/ tree.

.gitignore hygiene

Root file regrouped with comments; dead .dfx/ and _MACOSX entries dropped; stale dfx-era entries removed from motoko/ic-pos, rust/basic_bitcoin, rust/low_wasm_memory. Cargo.lock/mops.lock entries deliberately untouched — parked in #1457.

🤖 Generated with Claude Code

…icy, dfx-era cleanup

The dfx→icp-cli migration is complete, so the repo's meta files are
rewritten around what matters going forward:

- AGENTS.md: trimmed 551→~230 lines. Migration checklist and all version
  pins removed (versions come from the most recently updated examples);
  CI section rewritten around the reusable _run-example.yml; new
  conventions documented: environments are exactly 'local' and 'ic' (the
  'ic' name is the ICP Ninja deploy contract), canister:import +
  --actor-env-alias for inter-canister calls, version-bump scope rule,
  and the new-example acceptance criteria (from ADDING_AN_EXAMPLE.md).
- ICP skills: pinned setup per dfinity/icskills#251 — managed block in
  AGENTS.md (pinned, ask-to-update), committed skills-lock.json,
  .agents/skills gitignored (reinstall with npx skills).
- Contribution policy: CONTRIBUTING.md rewritten — not accepting external
  PRs while examples are being restructured to fit the developer docs;
  issues and forum posts remain welcome. ADDING_AN_EXAMPLE.md deleted
  (criteria folded into AGENTS.md).
- Dead machinery deleted: .ic-commit + its weekly update workflow and the
  orphaned provision/cache scripts (CI runs in icp-dev-env containers),
  plus .gitmodules (referenced a long-gone archive/ submodule).
- .gitignore hygiene: root file regrouped with comments; dead .dfx/ and
  _MACOSX entries dropped; stale dfx-era entries removed from three
  per-example .gitignore files. Lock-file entries unchanged per #1457.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@marc0olo
marc0olo marked this pull request as ready for review July 30, 2026 13:36
@marc0olo
marc0olo requested review from a team as code owners July 30, 2026 13:36
@marc0olo
marc0olo requested a review from Copilot July 30, 2026 13:36

@mraszyk mraszyk 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.

approving the simple change in rust/low_wasm_memory/.gitignore

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR updates repository meta-docs and housekeeping files to reflect the completed dfx → icp-cli migration, codifies forward-looking conventions for examples, and removes legacy CI/provisioning machinery that’s no longer used.

Changes:

  • Rewrites AGENTS.md to document current conventions (icp-cli-first, version placeholders, local/ic environments, inter-canister aliasing, canonical layouts).
  • Pins ICP agent skills via skills-lock.json and ignores local skill installations under .agents/skills.
  • Cleans up dfx-era artifacts and ignores (removes .ic-commit, submodule metadata, old provision/update scripts; trims per-example .gitignore entries).

Reviewed changes

Copilot reviewed 15 out of 16 changed files in this pull request and generated no comments.

Show a summary per file
File Description
skills-lock.json Adds a pinned skills lockfile for reproducible agent skill resolution.
AGENTS.md Replaces migration-era guidance with forward-looking repo conventions and updated templates.
.github/CONTRIBUTING.md Updates contribution policy to pause external PR acceptance and directs users to issues/forum for reports.
.gitignore Reorganizes ignore patterns; adds .agents/skills ignore; keeps existing lockfile ignore policy.
rust/low_wasm_memory/.gitignore Removes dfx-specific ignore entries that are no longer relevant.
rust/basic_bitcoin/.gitignore Removes dfx-era ignores and stale canister_ids.json ignore entry.
motoko/ic-pos/.gitignore Removes dfx-era ignores and stale canister_ids.json ignore entry.
ADDING_AN_EXAMPLE.md Removes redundant “add an example” doc now folded into AGENTS.md.
.ic-commit Removes legacy IC artifact pin used by old provisioning/update flows.
.gitmodules Removes unused submodule metadata referencing deleted archive/ content.
.github/workflows/update-ic-commit.yml Removes legacy scheduled workflow for updating IC artifacts.
.github/workflows/update-dfx-cache.sh Removes dfx-cache update script no longer used by CI.
.github/workflows/provision-pocket-ic-server.sh Removes legacy PocketIC provisioning script superseded by containerized CI.
.github/workflows/provision-linux.sh Removes legacy Linux provisioning script (toolchain now comes from CI container images).
.github/workflows/provision-darwin.sh Removes legacy macOS provisioning script (CI is containerized/Linux).
.github/workflows/pre-download-launcher.sh Removes launcher predownload workaround script that’s no longer referenced.

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

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.

4 participants