feat(agents): set up basic AI agent configuration (#1697)#1699
Merged
josecelano merged 13 commits intotorrust:developfrom Apr 21, 2026
Merged
feat(agents): set up basic AI agent configuration (#1697)#1699josecelano merged 13 commits intotorrust:developfrom
josecelano merged 13 commits intotorrust:developfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #1699 +/- ##
===========================================
+ Coverage 86.40% 86.41% +0.01%
===========================================
Files 288 288
Lines 22672 22672
Branches 22672 22672
===========================================
+ Hits 19590 19593 +3
+ Misses 2849 2843 -6
- Partials 233 236 +3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…dex, and templates - Add 19 agent skills under .github/skills/ covering git workflow, maintenance, planning, Rust code quality, and testing - Add scripts/pre-commit.sh: unified pre-commit check runner - Add scripts/install-git-hooks.sh: one-command git hook installer - Add .githooks/pre-commit: checked-in hook delegating to pre-commit.sh - Add docs/adrs/index.md: standalone ADR index table - Update docs/adrs/README.md: replace inline index with link to index.md - Add docs/templates/ADR.md and docs/templates/ISSUE.md - Update project-words.txt: add toplevel, behaviour, autolinks, backlinks, usize - Update docs/issues/1697-ai-agent-configuration.md: mark Task 2 complete
…exity auditor (torrust#1697) - Add .github/agents/committer.agent.md: commit specialist with GPG signing - Add .github/agents/implementer.agent.md: TDD implementer with sub-agent delegation - Add .github/agents/complexity-auditor.agent.md: cyclomatic/cognitive complexity checker - Update project-words.txt: add cyclomatic, analyse, penalise - Update docs/issues/1697-ai-agent-configuration.md: mark Tasks 3 and 4 complete
- Add .github/workflows/copilot-setup-steps.yml: prepares Copilot cloud agent environment before it starts working on any task - Triggers on workflow_dispatch, push and pull_request (scoped to file) - Steps: checkout (v6), stable Rust toolchain, rust-cache, cargo build, install linter, install cargo-machete, install git hooks, linter all - Update docs/issues/1697-ai-agent-configuration.md: mark Task 5 complete
- Add docs/adrs/20260420200013_adopt_custom_github_copilot_aligned_agent_framework.md: records the decision to build a custom GitHub-Copilot-aligned agent framework (AGENTS.md + Agent Skills + Custom Agents) over third-party alternatives (obra/superpowers, gsd-build/get-shit-done) - Update docs/adrs/index.md: add new ADR entry - Update project-words.txt: add specialised - Update docs/issues/1697-ai-agent-configuration.md: mark Task 6 complete
There was a problem hiding this comment.
Pull request overview
Adds a first-party AI agent framework for this Rust workspace (Torrust Tracker), centered around AGENTS.md guidance, Copilot Agent Skills, custom agent profiles, and supporting automation/docs so agents and contributors can follow consistent workflows.
Changes:
- Introduces repository + subdirectory
AGENTS.mdfiles and supporting docs/templates (issue/ADR templates, ADR entry). - Adds Agent Skills under
.github/skills/and custom agent profiles under.github/agents/. - Adds supporting automation: Copilot cloud-agent setup workflow, git hook installer, and a pre-commit verification script; cleans up cspell config/dictionary and ignores a generated artifact.
Reviewed changes
Copilot reviewed 39 out of 40 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
src/AGENTS.md |
Documents src/ responsibilities, bootstrap flow, AppContainer, and JobManager for agents/contributors. |
scripts/pre-commit.sh |
Adds a unified local pre-commit verification runner (deps check, lint, doc tests, tests). |
scripts/install-git-hooks.sh |
Installs repo-provided hooks from .githooks/ into .git/hooks/. |
project-words.txt |
Extends cspell project dictionary with additional technical terms. |
packages/AGENTS.md |
Adds workspace package layering + catalog guidance for agents/contributors. |
docs/templates/ISSUE.md |
Adds a standard issue template for consistent planning/specs. |
docs/templates/ADR.md |
Adds an ADR template for consistent architectural decision records. |
docs/issues/1697-ai-agent-configuration.md |
Marks the issue plan checklist items as completed and updates details. |
docs/adrs/index.md |
Registers the new ADR in the ADR index table. |
docs/adrs/README.md |
Improves ADR README guidance (naming, indexing, typical structure). |
docs/adrs/20260420200013_adopt_custom_github_copilot_aligned_agent_framework.md |
Adds ADR documenting the agent framework approach and alternatives. |
cspell.json |
Updates cspell ignore paths (including repomix-output.xml). |
cSpell.json |
Removes the duplicate cspell config file (case-variant). |
AGENTS.md |
Adds root-level agent/contributor instructions, commands, and conventions. |
.gitignore |
Ignores repomix-output.xml artifact. |
.github/workflows/copilot-setup-steps.yml |
Adds Copilot cloud agent setup workflow (toolchain, build warmup, linter/tools, hooks). |
.github/skills/dev/testing/write-unit-test/SKILL.md |
Adds a skill describing unit test conventions (naming, AAA, clocks, rstest). |
.github/skills/dev/rust-code-quality/handle-secrets/SKILL.md |
Adds a skill guiding secret handling (secrecy::Secret, exposure rules). |
.github/skills/dev/rust-code-quality/handle-errors-in-code/SKILL.md |
Adds a skill guiding structured error handling (thiserror, context/actionability, located-error). |
.github/skills/dev/planning/write-markdown-docs/SKILL.md |
Adds a skill documenting GFM pitfalls (notably #NUMBER autolinks). |
.github/skills/dev/planning/create-issue/SKILL.md |
Adds a skill describing spec-first issue creation workflow. |
.github/skills/dev/planning/create-adr/SKILL.md |
Adds a skill describing ADR creation + indexing workflow. |
.github/skills/dev/planning/cleanup-completed-issues/SKILL.md |
Adds a skill describing how to remove closed issue specs after merge. |
.github/skills/dev/maintenance/update-dependencies/SKILL.md |
Adds a skill guiding dependency update workflow and categorization. |
.github/skills/dev/maintenance/setup-dev-environment/SKILL.md |
Adds onboarding steps for a fresh development environment. |
.github/skills/dev/maintenance/install-linter/SKILL.md |
Adds a skill describing installing linter plus external tool dependencies. |
.github/skills/dev/git-workflow/run-pre-commit-checks/SKILL.md |
Adds a skill describing mandatory pre-commit gates and manual checks. |
.github/skills/dev/git-workflow/run-linters/references/linters.md |
Adds detailed linter reference documentation. |
.github/skills/dev/git-workflow/run-linters/SKILL.md |
Adds a skill describing how to run and debug linters. |
.github/skills/dev/git-workflow/review-pr/SKILL.md |
Adds a PR review checklist skill aligned to repo standards. |
.github/skills/dev/git-workflow/release-new-version/SKILL.md |
Adds a skill documenting the release workflow/branching/tagging/publishing steps. |
.github/skills/dev/git-workflow/open-pull-request/SKILL.md |
Adds a skill describing PR creation workflow and checks. |
.github/skills/dev/git-workflow/create-feature-branch/SKILL.md |
Adds a skill describing branch naming and lifecycle conventions. |
.github/skills/dev/git-workflow/commit-changes/SKILL.md |
Adds a skill describing Conventional Commits + GPG signing + pre-commit verification. |
.github/skills/add-new-skill/references/specification.md |
Adds a local reference summary of the Agent Skills spec. |
.github/skills/add-new-skill/SKILL.md |
Adds a meta-skill documenting how to create new skills in this repo. |
.github/agents/implementer.agent.md |
Adds a custom agent profile for TDD-oriented implementation workflow. |
.github/agents/complexity-auditor.agent.md |
Adds a custom agent profile for complexity auditing workflow. |
.github/agents/committer.agent.md |
Adds a custom agent profile for safe/reviewable committing workflow. |
.githooks/pre-commit |
Adds a git pre-commit hook that runs ./scripts/pre-commit.sh. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
|
wow! a massive set of general good advise :) |
…#1697) - Fix malformed YAML frontmatter in write-unit-test SKILL.md (file path prepended to opening delimiter; fix metadata field indentation) - Remove stale cSpell.json reference from run-linters/references/linters.md - Remove located-error and clock from Utilities/Test-support layer in packages/AGENTS.md (already listed in Domain/Shared) - Update AGENTS.md: remove torrust#1697 placeholders for .github/skills/ and .github/agents/ entries; remove cSpell.json from config table; fix nightly toolchain comment; update Auto-Invoke Skills section; fix Quick Navigation table last two rows to proper links
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 39 out of 40 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…ust#1697) - Fix install-git-hooks.sh: use git rev-parse --git-path hooks for HOOKS_DST to support git worktrees; add mkdir -p to ensure dir exists - Fix project-words.txt: restore alphabetical order for penalise (after peerlist), repomix (in re* section before repr), specialised (between socketaddr and sqllite), and toplevel (between tlsv and Torrentstorm); remove duplicates from near-end of file - Fix copilot-setup-steps.yml: expand push/pull_request path triggers to include scripts/install-git-hooks.sh and scripts/pre-commit.sh
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 39 out of 40 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
) - Fix MySQL test commands: replace torrust-tracker-core / tracker-core with the correct Cargo package name bittorrent-tracker-core in packages/AGENTS.md and run-pre-commit-checks/SKILL.md - Fix write-unit-test/SKILL.md: replace fictional Arc<dyn Clock> injection pattern and MockClock::new() constructor with the real type-level CurrentClock alias (clock::Working / clock::Stopped) and Stopped::local_set() for deterministic time in tests; also fix cargo test -p tracker-core -> bittorrent-tracker-core and update quick checklist
Member
Author
|
ACK 4fc97a0 |
44 tasks
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.
Progress
1697-ai-agent-configurationAGENTS.mdat the repository rootpackages/AGENTS.mdwith package architecture guide.github/skills/.github/agents/AGENTS.mdfiles in packagescopilot-setup-steps.ymlworkflow