diff --git a/README.md b/README.md index 024ef56..547ac1b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ A curated index of generic [agent skills](https://agentskills.io) installable with the [`gh skill`](https://github.blog/changelog/2026-04-16-manage-agent-skills-with-github-cli/) CLI (v2.90.0+). -This repo is a **pointer list**, not a publisher. Each row below installs directly from its original upstream so `gh skill` records the true source in the skill's `SKILL.md` frontmatter (`metadata.github-repo`, `github-path`, `github-ref`, `github-tree-sha`) and `gh skill update --all` works natively — no lockfile, no sync bot, no custom metadata. +This repo is a **pointer list** and publisher of in-house skills. Each row below is either an in-house skill or installs directly from its original upstream so `gh skill` records the true source in the skill's `SKILL.md` frontmatter (`metadata.github-repo`, `github-path`, `github-ref`, `github-tree-sha`) and `gh skill update --all` works natively — no lockfile, no sync bot, no custom metadata. ## Skills @@ -67,6 +67,7 @@ This repo is a **pointer list**, not a publisher. Each row below installs direct |-------|----------|---------| | `refactor` | [`github/awesome-copilot`](https://github.com/github/awesome-copilot/tree/main/skills/refactor) | `gh skill install github/awesome-copilot refactor` | | `test-driven-development` | [`obra/superpowers`](https://github.com/obra/superpowers/tree/main/skills/test-driven-development) | `gh skill install obra/superpowers test-driven-development` | +| `ways-of-working` | [`devantler-tech/skills`](https://github.com/devantler-tech/skills/tree/main/ways-of-working) | `gh skill install devantler-tech/skills ways-of-working` | @@ -97,7 +98,7 @@ All three rely on the `github-*` metadata that `gh skill install` injects into e This repository follows the [`agentskills.io`](https://agentskills.io) spec: skill directories live at the repository root and include a conformant `SKILL.md` at their root. Pull requests are validated by [`gh skill publish --dry-run`](.github/workflows/ci.yaml); releases are cut automatically by [semantic-release](https://semantic-release.gitbook.io/) on every push to `main` — [`release.yaml`](.github/workflows/release.yaml) uses [commit conventions](https://www.conventionalcommits.org/) to determine the next version, and [`cd.yaml`](.github/workflows/cd.yaml) then runs `gh skill publish` against the resulting tag. -The publish pipeline is retained for future in-house skills; until one is added, releases are no-ops. +The publish pipeline publishes in-house skills (e.g. `ways-of-working`) on each release. See the [devantler-tech organization guidelines](https://github.com/devantler-tech/.github) for PR/issue templates and general contribution rules. diff --git a/ways-of-working/SKILL.md b/ways-of-working/SKILL.md new file mode 100644 index 0000000..1017285 --- /dev/null +++ b/ways-of-working/SKILL.md @@ -0,0 +1,130 @@ +--- +name: ways-of-working +description: >- + Codifies devantler-tech engineering practices: agent-first development + workflow, TDD, CI/CD pipelines, GitHub Flow, code quality gates, + and Kubernetes workflows with ksail. Use when filing issues, planning + work, setting up projects, configuring CI/CD, writing tests, debugging, + or making architectural decisions. +license: Apache-2.0 +--- + +# Ways of Working + +## Development Workflow + +Development is agent-first — every change starts as a structured issue and flows through issue → plan → implement → test → review: + +1. **Create an issue** using the [devantler-tech/.github issue templates](https://github.com/devantler-tech/.github/tree/main/.github/ISSUE_TEMPLATE): + - **Feature** — user story with acceptance criteria. + - **Bug** — expected vs actual behavior with reproduction steps. + - **Chore** — user story with acceptance criteria for general tasks. + - **Kata** — Improvement Kata for continuous improvement (problem → definition of awesome → target condition → actions). +2. **Plan** — create a structured implementation plan from the issue before writing code. +3. **Implement** — execute the plan following the practices in this skill (TDD, quality gates, GitHub Flow, CI/CD). +4. **Manual test** — validate behavior hands-on before merging. Focus on UX: output must be well-presented and every piece of feedback (errors, warnings, prompts) must be actionable. +5. **Code review** (optional) — CI's strict linting, scanning, and quality gates are the primary feedback loop, so manual review is not always required. + +## Testing + +Follow the [test-driven-development](https://github.com/obra/superpowers/tree/main/skills/test-driven-development) skill rigorously — write the test first, watch it fail, write minimal code to pass. + +### Application / Library Repositories + +| Type | Tooling | When to run | +|------|---------|-------------| +| **Unit tests** | SDK test frameworks (e.g. `go test`, `xunit`, `jest`) | CI on every PR | +| **Integration tests** | SDK test frameworks | CI on every PR | +| **E2E / system tests** | GitHub Actions workflows that exercise the app/binary/service as an end user would | CI on every PR; move to `merge_group` if the suite becomes too heavy | +| **Benchmark tests** | SDK benchmark frameworks (e.g. `BenchmarkDotNet`, `go test -bench`) | CI on every PR | + +### Platform / Kubernetes Repositories + +For platform engineering work, [ksail](https://github.com/devantler-tech/ksail) provides the build → run → publish loop and [Testkube](https://testkube.io/) runs the actual test suites inside the cluster: + +| Type | App-repo equivalent | Tooling | What it does | +|------|---------------------|---------|--------------| +| **Linting / scanning** | Unit tests | Standard linters & scanners (e.g. kubeconform, kube-linter, Trivy) | Validate manifests statically — no cluster needed | +| **Integration tests** | Integration tests | Ephemeral local cluster (`ksail cluster create`) + Testkube | Spin up a Docker cluster, deploy workloads, and run Testkube test suites against them | +| **E2E / system tests** | E2E / system tests | Ephemeral or real cluster + Testkube | Deploy to a full environment (local or remote) and run end-to-end Testkube test suites | + +Platform lifecycle commands: + +| Command | Purpose | +|---------|---------| +| `ksail cluster init` | Scaffold a new cluster configuration | +| `ksail cluster create` | Spin up the cluster locally (Docker) or on real infrastructure and verify workloads reconcile | +| `ksail workload push` | Push Kubernetes manifests as OCI artifacts to a container registry | + +## Code Quality Gates (CI) + +Every pull request **must** pass: + +- **Strict linting** — language-specific linters with zero-tolerance for warnings. +- **Strict security scanning** — e.g. CodeQL, Trivy, zizmor. +- **Strict code quality scanning** — e.g. SonarQube, MegaLinter. +- **No code coverage regression** — coverage must not decrease compared to the base branch. +- **No benchmark regression** — benchmark results must not regress compared to the base branch. + +## Problem Solving + +- **Fix at the root cause** — never patch symptoms. Trace every bug or failure to its origin and fix it there. +- **Workarounds are always temporary** — if a workaround is unavoidable, mark it clearly (e.g. `// WORKAROUND:` comment with a linked issue) and schedule its removal. +- **Upstream first** — when a fix belongs in a dependency or upstream project, contribute it there. Only carry a local patch until the upstream change is released. + +## Libraries + +Prefer popular, well-maintained third-party libraries over writing custom implementations. Only roll your own when no suitable library exists or when the dependency would be disproportionately heavy. + +## Refactoring & Design + +Follow guidelines for refactoring techniques and design patterns. + +## Branching & Flow + +Use **GitHub Flow**: + +1. Create a feature branch from `main`. +2. Open a pull request. +3. Pass all CI checks. +4. Merge via merge queue (`merge_group`) when the repository is configured for it; otherwise merge the pull request normally. + +## CI/CD Pipeline + +Each repository has two core workflow files — `ci.yaml` and `cd.yaml` — plus a thin `release.yaml` that calls a reusable workflow (see [Releases](#releases)). Reusable logic is extracted into local GitHub Actions under `.github/actions/`: + +- **Composite actions** — for simple, self-contained steps. +- **TypeScript actions** — for anything complex, because they are locally testable and avoid hard-to-read bash embedded in YAML. + +### Application / Library Repositories + +| Event | What runs | +|-------|-----------| +| `pull_request` | All tests (unit, integration, E2E, benchmarks), linting, security & quality scanning, coverage & benchmark regression checks. Move E2E to `merge_group` only if the suite becomes too heavy. | +| `merge_group` | CD to **dev** environment. | +| `push` to `main` | **Publish** artifacts (packages, container images, etc.). | +| Semver tag (`vX.X.X`) | CD to **prod** environment. | + +### Platform / Kubernetes Repositories + +| Event | What runs | +|-------|-----------| +| `pull_request` | Linting & scanning (kubeconform, kube-linter, Trivy, etc.) plus integration tests on an ephemeral local cluster (`ksail cluster create` + Testkube). Move integration tests to `merge_group` if the suite becomes too heavy. | +| `merge_group` | CD to **dev** — deploy to staging infrastructure (e.g. Hetzner). | +| Semver tag (`vX.X.X`) | CD to **prod** — `ksail cluster update`, `ksail workload push`, `ksail workload reconcile`. | + +### Releases + +Releases are automated via the [`devantler-tech/reusable-workflows/.github/workflows/create-release.yaml`](https://github.com/devantler-tech/reusable-workflows/blob/main/.github/workflows/create-release.yaml) reusable workflow. It runs [semantic-release](https://semantic-release.gitbook.io/) on `push` to `main`, calculates the next semver from [conventional commit](https://www.conventionalcommits.org/) history, and creates the tag + GitHub release — which in turn triggers the CD pipeline above. + +For application publishing, always use upstream releasers — e.g. [GoReleaser](https://goreleaser.com/) for Go or [dotnet-releaser](https://github.com/xoofx/dotnet-releaser) for .NET — rather than hand-rolling publish scripts. + +## Data-Driven Improvement + +- Use **benchmarking data** to guide performance improvements — don't optimise without numbers. +- Use **code coverage data** to guide where to add tests — target uncovered paths, not a vanity percentage. + +## Reference Implementations + +- [devantler-tech/ksail](https://github.com/devantler-tech/ksail) — Go CLI built with TDD, full CI/CD pipeline, benchmarks, and E2E system tests in GitHub Actions. +- [devantler-tech/platform](https://github.com/devantler-tech/platform) — Kubernetes platform using ksail for init → create → push OCI workflow, with progressive CI (Docker → Hetzner staging → Hetzner prod).