Skip to content
Merged
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
6 changes: 3 additions & 3 deletions .github/agents/code-review.agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ Follow these stages sequentially to perform a complete review. Do not skip stage
- **How-to guides**: `docs/how-to/*.rst`
- **Explanation articles**: `docs/explanation/**/*.rst`
- **Release notes**: `docs/release-notes/*.md` (for recent features)
- **README/Contributing**: `docs/readme.rst`, `docs/contributing.rst`
- **README/Contributing**: `docs/readme.rst`, `docs/contributing.rst`, `docs/contributing/development.rst`
- **Definition file references**: `docs/reference/definition-files/*.rst`

3. **Record Evidence for Each Finding** (internal validation only):
Expand Down Expand Up @@ -252,7 +252,7 @@ Follow these stages sequentially to perform a complete review. Do not skip stage

### Stage 7: Commit Message & PR Description Review
**Intent**: Ensure commit messages and PR descriptions follow project conventions.
**Inputs**: Commit messages, PR description, [`docs/contributing.rst`](../../docs/contributing.rst).
**Inputs**: Commit messages, PR description, [`docs/contributing/development.rst`](../../docs/contributing/development.rst).
**Actions**:
- **Commit Message Format**:
- Start with capitalized summary (no type prefix for code commits)
Expand Down Expand Up @@ -389,7 +389,7 @@ All changed entities are properly documented across appropriate Diátaxis pillar

### Always Do
- **Reference `docs/coding-style-guide.md`** when making style suggestions.
- Check commit message format against [`docs/contributing.rst`](../../docs/contributing.rst).
- Check commit message format against [`docs/contributing/development.rst`](../../docs/contributing/development.rst).
- Use the coverage mechanism (`docs/.coverage.yaml` and `docs/coverage.md`) to identify documentation gaps.
- **Complete verification pass (Stage 6, Sub-stage B)** before reporting documentation findings — search actual docs corpus with ≥2 query variants.
- **Provide evidence for all documentation claims**: Include search terms, file paths, line numbers, or explicit "no matches" statements.
Expand Down
20 changes: 11 additions & 9 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This file provides general project context for GitHub Copilot. For review-specific guidance, see:
- **Code Review**: `.github/agents/code-review.agent.md`
- **Documentation Review**: `.github/agents/doc-review.agent.md`
- **Documentation Review**: `.github/skills/documentation-review/SKILL.md`

## Project Overview

Expand Down Expand Up @@ -37,7 +37,7 @@ Workshop is a tool for defining and handling ephemeral development environments.

## Coding Guidelines

See [`docs/contributing.rst`](../docs/contributing.rst) for detailed standards. Key points:
See [`docs/coding-style-guide.md`](../docs/coding-style-guide.md) for detailed standards. Key points:

- **Error messages**: Lowercase, no trailing punctuation, actionable (`what was attempted: why it went wrong`)
- **Error handling**: Consistent `if err := f(); err != nil { return err }` pattern
Expand All @@ -63,11 +63,11 @@ See [`docs/contributing.rst`](../docs/contributing.rst) for detailed standards.

## Available Resources

- **Contributing Guide**: [`docs/contributing.rst`](../docs/contributing.rst) — Setup, standards, workflow
- **Contributing Guide**: [`docs/contributing/development.rst`](../docs/contributing/development.rst) — Setup, testing, workflow
- **Documentation Style**: [`docs/doc-style-guide.md`](../docs/doc-style-guide.md) — reST/Markdown conventions
- **PR Template**: [`.github/pull_request_template.md`](.github/pull_request_template.md) — Self-review checklist
- **Code Review Agent**: [`.github/agents/code-review.agent.md`](.github/agents/code-review.agent.md) — For PR code reviews
- **Docs Review Agent**: [`.github/agents/doc-review.agent.md`](.github/agents/doc-review.agent.md) — For PR documentation reviews
- **Documentation Review Skill**: [`.github/skills/documentation-review/SKILL.md`](skills/documentation-review/SKILL.md) — For documentation reviews

## Related Repositories

Expand All @@ -85,15 +85,17 @@ These external repositories provide authoritative context for the Workshop proje
- `cover.yaml` — Coverage reports
- `automatic-doc-checks.yml` — Sphinx builds (fail on warnings)
- `doc-cover.yaml` — Documentation coverage map generation
- `doc-update-sdk-schema.yml` — Updates SDK schema in docs
- `fix-redirected-links.yml` — Updates selected redirecting documentation links
- `release.yaml` — Builds release snaps + generates CLI reference PR
- `fixup.yaml` — Commit message format validation
- `scanning.yml` — Security scanning
- `sphinx-python-dependency-build-checks.yml` — Ensures Sphinx venv builds
- `markdown-style-checks.yml` — Checks style, spelling, and links
- `markdown-style-checks.yml` — Markdown linting
- `build-deps.yaml` — Build dependencies check
- `doc-update-sdk-schema.yml` — Updates SDK schema in docs
- `lxd-candidate-check.yml` — Checks LXD candidate channel
- `update-starter-pack.yml` — Updates documentation starter pack
- `lxd-candidate-check.yaml` — Checks LXD candidate channel
- `staging.yaml` — Rejects staged test SDKs
- `update-sphinx-stack.yaml` — Updates Sphinx Stack files and documentation dependencies
- `zizmor.yaml` — Audits GitHub Actions workflows

## Evolution Note

Expand Down
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
* [ ] Put variable declaration and initialisation together.
* [ ] Divide large expressions into digestable and self-explanatory ones. Use multiple variables if required.
* [ ] Put a blank line between two logically different chunks of code.
* [ ] Follow the [style guide](https://github.com/canonical/workshop/tree/main/docs/contributing.rst#error-messages) for new error messages.
* [ ] Follow the [style guide](https://github.com/canonical/workshop/tree/main/docs/coding-style-guide.md#error-handling) for new error messages.

## Docs

Expand Down
1 change: 1 addition & 0 deletions docs/.custom_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ subcommand
subcommands
subdirectory
subgraph
subshell
sudo
symlinked
symlinks
Expand Down
4 changes: 2 additions & 2 deletions docs/coding-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ return fmt.Errorf("%s must be a map or one of the shortcuts 'true' or 'false'",
return fmt.Errorf("workshop %s not found", name)
```

**Rationale**: `%q` is backed by `strconv.Quote`, the same primitive as `strutil.Quoted`, so dynamic values render consistently across error messages, log output, and list helpers. Reserving backticks as Go raw-string delimiters and double quotes for both literals and `%q` output keeps every quoted artifact in the final message visually uniform. The `docs/contributing.rst` Error messages guidance (path and identifier double-quoting) is the precedent.
**Rationale**: `%q` is backed by `strconv.Quote`, the same primitive as `strutil.Quoted`, so dynamic values render consistently across error messages, log output, and list helpers. Reserving backticks as Go raw-string delimiters and double quotes for both literals and `%q` output keeps every quoted artifact in the final message visually uniform. The same path and identifier double-quoting applies across Workshop's error messages.


---
Expand Down Expand Up @@ -1516,4 +1516,4 @@ When contributing code:
5. Keep changes focused and atomic
6. Write clear commit messages

For detailed contribution guidelines, see the [Contributing Guide](contributing.rst) in the documentation.
For detailed contribution guidelines, see {ref}`Contribute to development <contributing_development>`.
Loading
Loading