Skip to content

Commit 14b6135

Browse files
josecelanojosecelano
committed
docs(agents): fix inconsistencies found in Copilot PR review (#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 #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
1 parent f35cd74 commit 14b6135

5 files changed

Lines changed: 28 additions & 26 deletions

File tree

‎.github/skills/dev/git-workflow/run-linters/references/linters.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Key formatting settings:
5252
### cspell (Spell Checker)
5353

5454
**Tool**: cspell
55-
**Config**: `cspell.json`, `cSpell.json`
55+
**Config**: `cspell.json`
5656
**Dictionary**: `project-words.txt`
5757
**Run**: `linter cspell`
5858

‎.github/skills/dev/testing/write-unit-test/SKILL.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
.github/skills/dev/testing/write-unit-test/SKILL.md---
1+
---
22
name: write-unit-test
33
description: Guide for writing unit tests following project conventions including behavior-driven naming (it*should*\*), AAA pattern, MockClock for deterministic time testing, and parameterized tests with rstest. Use when adding tests for domain entities, value objects, utilities, or tracker logic. Triggers on "write unit test", "add test", "test coverage", "unit testing", or "add unit tests".
44
metadata:
5-
author: torrust
6-
version: "1.0"
7-
5+
author: torrust
6+
version: "1.0"
87
---
98

109
# Writing Unit Tests

‎AGENTS.md‎

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ native IPv4/IPv6 support, private/whitelisted mode, and a management REST API.
4747
- `share/default/` — Default configuration files and fixtures
4848
- `storage/` — Runtime data (git-ignored); databases, logs, config
4949
- `.github/workflows/` — CI/CD workflows (testing, coverage, container, deployment)
50-
- `.github/skills/` — Agent Skills for specialized workflows _(to be added — see issue #1697)_
51-
- `.github/agents/` — Custom Copilot agents _(to be added — see issue #1697)_
50+
- `.github/skills/` — Agent Skills for specialized workflows and task-specific guidance
51+
- `.github/agents/` — Custom Copilot agents and their repository-specific definitions
5252

5353
## 📦 Package Catalog
5454

@@ -106,19 +106,19 @@ All packages live under `packages/`. The workspace version is `3.0.0-develop`.
106106

107107
## 📄 Key Configuration Files
108108

109-
| File | Used by |
110-
| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
111-
| `.markdownlint.json` | markdownlint |
112-
| `.yamllint-ci.yml` | yamllint |
113-
| `.taplo.toml` | taplo (TOML formatting) |
114-
| `cspell.json` / `cSpell.json` | cspell (spell checker) — both filenames exist in the repo |
115-
| `project-words.txt` | cspell project-specific dictionary |
116-
| `rustfmt.toml` | rustfmt (`group_imports = "StdExternalCrate"`, `max_width = 130`) |
117-
| `.cargo/config.toml` | Cargo aliases (`cov`, `cov-lcov`, `cov-html`, `time`) and global `rustflags` (`-D warnings`, `-D unused`, `-D rust-2018-idioms`, …) |
118-
| `Cargo.toml` | Cargo workspace root |
119-
| `compose.yaml` | Docker Compose for local dev and demo |
120-
| `Containerfile` | Container image definition |
121-
| `codecov.yaml` | Code coverage configuration |
109+
| File | Used by |
110+
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
111+
| `.markdownlint.json` | markdownlint |
112+
| `.yamllint-ci.yml` | yamllint |
113+
| `.taplo.toml` | taplo (TOML formatting) |
114+
| `cspell.json` | cspell (spell checker) configuration |
115+
| `project-words.txt` | cspell project-specific dictionary |
116+
| `rustfmt.toml` | rustfmt (`group_imports = "StdExternalCrate"`, `max_width = 130`) |
117+
| `.cargo/config.toml` | Cargo aliases (`cov`, `cov-lcov`, `cov-html`, `time`) and global `rustflags` (`-D warnings`, `-D unused`, `-D rust-2018-idioms`, …) |
118+
| `Cargo.toml` | Cargo workspace root |
119+
| `compose.yaml` | Docker Compose for local dev and demo |
120+
| `Containerfile` | Container image definition |
121+
| `codecov.yaml` | Code coverage configuration |
122122

123123
## 🧪 Build & Test
124124

@@ -127,7 +127,7 @@ All packages live under `packages/`. The workspace version is `3.0.0-develop`.
127127
```sh
128128
rustup show # Check active toolchain
129129
rustup update # Update toolchain
130-
rustup toolchain install nightly # Required: pre-commit hooks use cargo +nightly fmt/check/doc
130+
rustup toolchain install nightly # Optional: only needed for manual cargo +nightly doc; the repo hook runs ./scripts/pre-commit.sh
131131
```
132132

133133
### Build
@@ -349,7 +349,8 @@ See [docs/containers.md](docs/containers.md) for detailed container documentatio
349349

350350
## 🎯 Auto-Invoke Skills
351351

352-
Agent Skills will be available under `.github/skills/` once issue #1697 is implemented.
352+
Agent Skills live under [`.github/skills/`](.github/skills/). Each skill is a `SKILL.md` file
353+
with YAML frontmatter and Markdown instructions covering a repeatable workflow.
353354

354355
> Skills supplement (not replace) the rules in this file. Rules apply always; skills activate
355356
> when their workflows are needed.
@@ -384,5 +385,5 @@ Agent Skills will be available under `.github/skills/` once issue #1697 is imple
384385
| Run profiling | [`docs/profiling.md`](docs/profiling.md) |
385386
| Understand the release process | [`docs/release_process.md`](docs/release_process.md) |
386387
| Report a security vulnerability | [`SECURITY.md`](SECURITY.md) |
387-
| Agent skills reference | `.github/skills/` _(coming — see issue #1697)_ |
388-
| Custom agents reference | `.github/agents/` _(coming — see issue #1697)_ |
388+
| Agent skills reference | [`.github/skills/`](.github/skills/) |
389+
| Custom agents reference | [`.github/agents/`](.github/agents/) |

‎packages/AGENTS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ depend on packages in the same layer or a lower one.
2828
│ events metrics clock located-error server-lib │
2929
├────────────────────────────────────────────────────────────────┤
3030
│ Utilities / Test support │
31-
│ test-helpers located-error clock │
31+
│ test-helpers │
3232
└────────────────────────────────────────────────────────────────┘
3333
```
3434

‎scripts/pre-commit.sh‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,9 @@ run_step() {
4949
echo "[Step ${step_number}/${total_steps}] ${description}..."
5050

5151
local step_start=$SECONDS
52-
eval "${command}"
52+
local -a cmd_array
53+
read -ra cmd_array <<< "${command}"
54+
"${cmd_array[@]}"
5355
local step_elapsed=$((SECONDS - step_start))
5456

5557
echo "PASSED: ${success_message} ($(format_time "${step_elapsed}"))"

0 commit comments

Comments
 (0)