// Guide for committing changes in the torrust-tracker-demo repository. Covers running all linters locally before committing to ensure CI passes. Triggers on "commit", "how to commit", "before committing", "pre-commit checks", "run linters", "check before commit".
Workflow for checking whether UDP packet loss or uptime degradation may be caused by conntrack saturation on the torrust-tracker-demo server. Use when diagnosing UDP timeouts, low newTrackon uptime, packet drops, conntrack pressure, UDP receive-buffer errors, or when validating whether conntrack tuning is still healthy.
Step-by-step process for creating and opening a GitHub issue in the torrust-tracker-demo repository. Use when asked to open, create, or file an issue. Covers writing the draft file, human review, opening on GitHub, renaming the file, and committing. Triggers on "open issue", "create issue", "new issue", "file issue", "draft issue".
Step-by-step workflow for resizing (scaling up) the Hetzner server in the torrust-tracker-demo stack. Use when asked to resize, scale up, or upgrade the server plan. Covers pre-resize preparation, graceful shutdown, provider panel action, post-resize recovery, and evidence capture. Triggers on "resize server", "scale up", "upgrade server plan", "Hetzner resize", "change server type".
Workflow for investigating server and service performance bottlenecks in the torrust-tracker-demo repository. Use when debugging uptime degradation, high load, latency spikes, dropped packets, or suspected capacity limits. Triggers on "performance issue", "high load", "uptime drop", "bottleneck", "capacity", "scaling", "degraded service", "newTrackon uptime".
Create and open a pull request in the torrust-tracker-demo repository. Use when asked to open a PR, create a pull request, submit a PR, or push changes and create a PR. Triggers on "open PR", "create PR", "submit PR", "push and open PR", "open pull request".
Create a git branch to start working on a GitHub issue in the torrust-tracker-demo repository. Use when asked to start working on an issue, create a branch for an issue, or check out a new branch. Triggers on "create branch", "new branch", "start working on issue", "branch for issue", "checkout branch".
| name | commit |
| description | Guide for committing changes in the torrust-tracker-demo repository. Covers running all linters locally before committing to ensure CI passes. Triggers on "commit", "how to commit", "before committing", "pre-commit checks", "run linters", "check before commit". |
| metadata | {"author":"torrust","version":"1.0"} |
Always run the linters locally before committing to avoid CI failures.
Critical rule: Never mix skill/workflow documentation changes (.github/skills/, .github/agents/, AGENTS.md) with implementation changes in a single commit.
When a change affects both documentation/skills and implementation:
docs)feat, fix, etc.)This keeps changes logically separated and makes the commit history easier to review.
Install the linter binary once:
cargo install torrust-linting --locked
Also requires: Node.js ≥ 20, yamllint, and shellcheck available on $PATH.
./scripts/pre-commit.sh
This is the pre-commit entry point and currently delegates to ./scripts/lint.sh.
It runs markdown, YAML, spell check, and shell script linters in sequence and
stops on first failure.
The repository also provides a tracked Git hook at .githooks/pre-commit.
Enable it locally with:
git config core.hooksPath .githooks
Fix all reported issues before committing. Add any new project-specific words to
project-words.txt (one word per line).
All commits must be GPG-signed.
Follow Conventional Commits:
<type>[optional scope]: <short description>
[optional body]
Types: feat, fix, docs, chore, refactor.
When updating documentation for skills or workflows, use docs type. Implementation changes use their appropriate type (feat, fix, etc.) in a separate commit.