Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
355 changes: 0 additions & 355 deletions .github/agents/evals/living-doc-bdd-copilot/evals.json

This file was deleted.

27 changes: 0 additions & 27 deletions .github/agents/evals/living-doc-bdd-copilot/fixture-map.md

This file was deleted.

360 changes: 0 additions & 360 deletions .github/agents/living-doc-bdd-copilot.agent.md

This file was deleted.

1 change: 1 addition & 0 deletions .github/workflows/check-pr-requirements.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,4 @@ jobs:
check-title: "true"
check-description: "true"
check-issue-reference: "true"
title-formats: "conventional,issue-number"
60 changes: 0 additions & 60 deletions .github/workflows/test-scripts.yml

This file was deleted.

22 changes: 4 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,6 @@ skills/
| `assets/` | Template files, example inputs/outputs, icons — anything the skill produces or consumes |
| `evals/` | Test prompts and assertions to verify skill behavior and trigger accuracy. See [skill-testing.md](./docs/testing/skill-testing.md) |

#### `references/` — shared vs. skill-specific

- **`skills/<skill>/references/`** — skill-specific docs loaded only by that skill's instructions
- **`skills/shared/references/`** — shared docs used by multiple skills (e.g., schemas, glossaries, common API specs)

If a reference file is used by 2+ skills, place it in `skills/shared/references/` instead of duplicating it. See [living-doc-bdd-schemas.md](skills/shared/references/living-doc-bdd-schemas.md) and [living-doc-glossary.md](skills/shared/references/living-doc-glossary.md) for examples.
---

## 2. Frontmatter schema
Expand Down Expand Up @@ -183,18 +177,10 @@ should be run") — it is clearer and easier for the agent to follow.

If every test run of your skill independently writes the same helper script (a formatter, a validator, a transformer), bundle it in `scripts/` and reference it from `SKILL.md`. This saves every future invocation from reinventing the wheel.

### Shared utilities and assets across multiple skills

**Pattern:** If code, references, or assets are used by 2+ skills, place them in `skills/shared/`:

- **`skills/shared/lib/`** for shared Python modules → each skill has a wrapper
- **`skills/shared/references/`** for shared documentation → skills link directly
- **`skills/shared/assets/`** for shared templates/data → skills reference relative paths

Examples:
- `skills/shared/lib/living_doc_id.py` — shared by three living-doc skills
- `skills/shared/references/living-doc-glossary.md` — shared by multiple living-doc skills
- See [skills/shared/lib/README.md](skills/shared/lib/README.md) for implementation details
**No CI runs script tests today.** The workflow that discovered and ran `skills/**/test_*.py` was removed once the
last tested script left the repository, so a `test_*.py` you add now will never run in CI. If you bundle a script
worth testing, restore that workflow in the same PR — otherwise the tests pass locally and nothing enforces them
afterwards.

**Benefits:** Single source of truth, prevents drift, easier maintenance, each skill remains independently deployable.

Expand Down
23 changes: 0 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,20 +78,7 @@ its purpose, trigger phrases, and full instructions.
| Skill | Description |
|------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
| **[accessibility-infra-setup](./skills/accessibility-infra-setup/)** | Set up automated accessibility (a11y) check infrastructure in an existing Angular app with Playwright + axe-core (WCAG 2.2 AA) — detects existing test setup, scaffolds config, a shared axe fixture, one dummy example scan, npm scripts, and docs, then validates the sample passes. |
| **[bdd-maintain](./skills/bdd-maintain/)** | REMOVE and DEAD CODE AUDIT modes — delete feature files, step definitions, and PageObjects linked to
| **[create-repository](./skills/create-repository/)** | Creates and configures a GitHub repository under AbsaOSS (open source) or absa-group (internal). Runs a short interview, then shows an annotated `gh` command plan and executes it on confirmation — visibility, naming, admins, CODEOWNERS, labels, merge settings, and project links. |
| **[data-cy-instrument](./skills/data-cy-instrument/)** | Resolve missing `data-cy` attributes in Angular component templates and sync PageObjects to use `getByTestId()` — run after a crawl when `coverage_gaps` are non-empty. |
| **[gherkin-living-doc-sync](./skills/gherkin-living-doc-sync/)** | Synchronise Gherkin feature files with the living documentation catalog — fix missing AC traceability headers, step text drift, and stale scenario links. |
| **[gherkin-step](./skills/gherkin-step/)** | Implement clean, reusable step definitions — behave (Python), Cucumber (Java, TypeScript, Scala), parameter types, DataTable, DocString, and hooks. |
| **[living-doc-create-user-story](./skills/living-doc-create-user-story/)** | Create a well-formed User Story with business-level Acceptance Criteria that are traceable, testable, and E2E-ready. |
| **[living-doc-create-feature](./skills/living-doc-create-feature/)** | Document a system surface (UI screen, API endpoint, service) as a Feature entity with ownership and traceability links. |
| **[living-doc-create-functionality](./skills/living-doc-create-functionality/)** | Define an atomic, testable behaviour (Functionality) with AC designed for fast unit or integration tests. |
| **[living-doc-update](./skills/living-doc-update/)** | Amend or deprecate existing User Story, Feature, or Functionality entities — add ACs, change status, update ownership. |
| **[living-doc-impact-analysis](./skills/living-doc-impact-analysis/)** | Trace which Features, Functionalities, User Stories, and Gherkin scenarios are affected by a code change or PR. |
| **[living-doc-gap-finder](./skills/living-doc-gap-finder/)** | Identify undocumented behaviours, orphan tests, and untested ACs. Used by `@living-doc-bdd-copilot` top-down (catalog gaps) and bottom-up (scenario coverage). |
| **[living-doc-pageobject-scan](./skills/living-doc-pageobject-scan/)** | Discover, create, and maintain PageObject classes from a live web application — bootstrapping from scratch and detecting selector drift after UI changes. |
deprecated entities; audit unused steps and PageObject methods. |
| **[living-doc-scenario-creator](./skills/living-doc-scenario-creator/)** | Generate full Gherkin feature files from User Story and Functionality ACs — feature file header, @AC:-tagged scenarios, complete Given/When/Then step bodies, coverage report, and step definition resolution. |
| **[pr-review](./skills/pr-review/)** | Pull request code review — reviews diffs for risk, security issues, API contract changes, dependency bumps, CI/CD and infrastructure changes. Produces concise Blocker / Important / Nit comments. |
| **[tdd-workflow](./skills/tdd-workflow/)** | Test-driven development: upfront SPEC.md planning + confirmation gate (avoids batch design), then vertical-sliced implementation (one test → one code cycle at a time, not all tests then all code). |
| **[test-data-management](./skills/test-data-management/)** | Test data setup and management — factory functions, parametrised tests, deterministic seeds, fixture reuse, and production-data rules for unit and integration tests. |
Expand All @@ -101,16 +88,6 @@ deprecated entities; audit unused steps and PageObject methods. |
| **[test-unit-review](./skills/test-unit-review/)** | Systematically audit unit test suites. Runs test runner, checks isolation/scope/naming/assertions/coverage standards, and reports findings by severity (Blocker / Important / Nit). |
| **[token-saving](./skills/token-saving/)** | Always-active response discipline — enforces brevity, no filler openers or closers, structured output, and a What/Why/How footer on code responses. Suspends on explicit "full detail" requests. |

## Agent Roster

Agents are pre-configured AI personas that orchestrate multiple skills for a specific engineering phase. Agent files live in **[.github/agents/](./.github/agents/)**.



| Agent | Description |
|---|---|
| **[@living-doc-bdd-copilot](./.github/agents/living-doc-bdd-copilot.agent.md)** | Living documentation and BDD automation — catalog management (User Stories, Features, Functionalities, AC updates, impact analysis, gap finding) and automation (webapp exploration, PageObjects, Gherkin scenarios, step definitions, BDD suite maintenance). |

## Finding More Skills

Before building a new skill, check whether one already exists:
Expand Down
45 changes: 0 additions & 45 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,9 @@ Navigation hub for all guides in this repository. Browse by category below.
- [Repository Guides](#repository-guides)
- [Agent Development Guides](#agent-development-guides)
- [Tools for Agentic Development](#tools-for-agentic-development)
- [Agent Guides](#agent-guides)
- [Skill Guides](#skill-guides)
- [Solo Skills (Standalone, No Dependencies)](#solo-skills-standalone-no-dependencies)
- [QA And Testing Skills](#qa-and-testing-skills)
- [Living Documentation & BDD Skills](#living-documentation--bdd-skills)
- [Catalog & Entity Creation](#catalog--entity-creation)
- [BDD Workflow & Automation](#bdd-workflow--automation)
- [Analysis & Maintenance](#analysis--maintenance)

## Repository Guides

Expand All @@ -33,7 +28,6 @@ Core practices for designing, testing, and deploying agent workflows with Copilo

| Guide | Description |
|-----------------------------------------|-------------------------------------------------------------------------------------|
| [Agent Design Best Practices](./guides/agent-design.md) | Core principles, file structure, context management, tool guidance, examples, and stopping conditions for `.agent.md` files |
| [Responsible Agent Use](./responsible-agent-use.md) | Not burning your Copilot token budget — context, models, agent mode, MCP, plugins, skills, and a must-do checklist |
| [Agent Testing](./testing/agent-testing.md) | Eval creation and body quality testing for `.agent.md` files — agents are invoked by @-mention, not auto-triggered |

Expand All @@ -48,14 +42,6 @@ CLI-based agents and dashboards for terminal-driven coding and cost tracking.
| [GitHub Copilot CLI](./tools/copilot-cli.md) | Multi-model agentic terminal agent with native GitHub integration |
| [CodeBurn](./tools/codeburn.md) | Token usage, cost, and performance dashboard for 25+ AI coding tools |

## Agent Guides

Orchestrated agent workflows that coordinate multiple skills for complex tasks.

| Guide | Description |
|-----------------------------------------------|-------------------------------------------------------------------------|
| [Living Doc BDD Copilot](./guides/living-doc-bdd-copilot.md) | Living documentation and BDD automation — catalog management (User Stories, Features, Functionalities, AC updates, impact analysis, gap finding) and automation (webapp exploration, PageObjects, Gherkin, step definitions, maintenance) |

## Skill Guides

Task-specific guidance for using individual skills. Start by picking your use case below.
Expand All @@ -80,37 +66,6 @@ Task-specific guidance for using individual skills. Start by picking your use ca
| [Test Data Management](./guides/test-data-management.md) | How the test-data-management skill works, what it covers, and when it fires |
| [Test Mocking Patterns](./guides/test-mocking-patterns.md) | Double selection, patching strategies, cleanup, and language-specific guidance |

### Living Documentation & BDD Skills

**Start here:** [`@living-doc-bdd-copilot`](./guides/living-doc-bdd-copilot.md) — orchestrates the full workflow.

#### Catalog & Entity Creation

| Guide | Description |
|---|---|
| [Create User Story](./guides/living-doc-create-user-story.md) | Author well-formed User Stories with business-level ACs ready for E2E scenarios |
| [Create Feature](./guides/living-doc-create-feature.md) | Document system surfaces (UI screens, APIs, services) as Feature entities |
| [Create Functionality](./guides/living-doc-create-functionality.md) | Define atomic, testable behaviors with Acceptance Criteria for unit/integration tests |
| [Update Living Doc](./guides/living-doc-update.md) | Amend entities: add ACs, change status, deprecate, update ownership and links |

#### BDD Workflow & Automation

| Guide | Description |
|---|---|
| [Gherkin Step Definitions](./guides/gherkin-step.md) | Multi-language step definition patterns: Python behave, TypeScript/Java Cucumber, Scala; state sharing, hooks, parameter types |
| [Scenario Creator](./guides/living-doc-scenario-creator.md) | Convert User Story and Functionality ACs to Gherkin scenarios with full traceability tagging |
| [Gherkin ↔ Living Doc Sync](./guides/gherkin-living-doc-sync.md) | Keep scenarios and ACs in sync: audit AC links, fix drift, propagate changes |
| [PageObject Scan](./guides/living-doc-pageobject-scan.md) | Discover, create, and maintain Playwright PageObjects: bootstrap, re-scan after UI changes, heal selector drift |
| [Data-Cy Instrument](./guides/data-cy-instrument.md) | Add missing test-id attributes to templates; sync PageObjects to use `getByTestId()` |

#### Analysis & Maintenance

| Guide | Description |
|----|----|
| [BDD Maintenance](./guides/bdd-maintain.md) | Clean up BDD artifacts: remove deprecated feature files, find dead code, audit unused steps and PageObject methods |
| [Gap Finder](./guides/living-doc-gap-finder.md) | Audit living doc completeness: find undocumented features, orphan tests, untested ACs; produce gap reports |
| [Impact Analysis](./guides/living-doc-impact-analysis.md) | Trace PR impact on living doc: identify affected Features, Functionalities, User Stories; determine what to review/re-test |

> **Keep this index up to date.** When you add a new guide, add a row to the appropriate table above.

See also the [main README](../README.md) for the skill catalog, scope, and FAQ.
49 changes: 0 additions & 49 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,55 +141,6 @@ your-project-repo/
└── SKILL.md
```

## Install Agents

Agents are pre-configured AI personas that orchestrate multiple skills for a specific engineering phase. Unlike skills (which are auto-activated by description matching), agents are invoked explicitly by name in Copilot Chat.

### How agents differ from skills

| | Skills | Agents |
|---|---|---|
| Activation | Auto — triggered when your prompt matches the description | Manual — you @-mention the agent name |
| Scope | Any compatible tool (Copilot, Claude, Cursor) | GitHub Copilot Chat (VS Code) |
| Install location | `~/.agents/skills/` or `.github/skills/` | `.github/agents/` inside your project repo |

### Install an agent into your project

Copy the agent file into your project's `.github/agents/` directory:

```bash
# One-time setup
mkdir -p .github/agents

# Copy the agent
cp path/to/agentic-toolkit/.github/agents/living-doc-bdd-copilot.agent.md .github/agents/
```

Or clone the toolkit and copy all agents:

```bash
git clone https://github.com/AbsaOSS/agentic-toolkit.git
cp agentic-toolkit/.github/agents/*.agent.md .github/agents/
```

Commit the `.github/agents/` directory to share the agents with your team.

### Use an agent in Copilot Chat

Open Copilot Chat in VS Code and type `@` followed by the agent name:

```
@living-doc-bdd-copilot create user story for the login feature
@living-doc-bdd-copilot living doc gaps
@living-doc-bdd-copilot HEALING mode
```

The agent loads its skills on demand and follows its defined scope.

> ⚠️ **Agents are invoked only via `@-mention`** — the `description` field in an agent file is for documentation only, not an activation trigger (unlike skills). Type `@agent-name` explicitly in Copilot Chat to invoke the agent.

See the [Agent Roster](../README.md#agent-roster) for the full list of available agents and their guides.

## Troubleshooting

Running into issues? See **[docs/troubleshooting.md](./troubleshooting.md)** guide.
Loading
Loading