Skip to content
This repository was archived by the owner on Oct 10, 2025. It is now read-only.

Commit 91e6e67

Browse files
committed
docs: [#10] update project dictionary and GitHub Copilot instructions
- Add infrastructure and networking terms to project-words.txt - Update GitHub Copilot instructions with project context and conventions - Improve documentation for the local testing environment setup
1 parent 5d57840 commit 91e6e67

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

.github/copilot-instructions.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,22 @@ This repository contains all the configuration needed to run the live Torrust Tr
33
The main goal is to provide a simple and easy-to-use setup for the Torrust Tracker, which can be deployed on a single server.
44

55
The current major initiative is to migrate the tracker to a new infrastructure on Hetzner. This involves:
6+
67
- Running the tracker binary directly on the host for performance.
78
- Using Docker for supporting services like Nginx, Prometheus, Grafana and MySQL.
89
- Migrating the database from SQLite to MySQL.
910

1011
When providing assistance, please act as an experienced open-source developer and system administrator.
1112

1213
Follow these conventions:
14+
1315
- Use Conventional Commits for commit messages. Include the issue number in this format `#1` in the commit message if applicable, e.g., `feat: [#1] add new feature`.
14-
- The issue number should be the branch prefix, e.g., `feat: [#1] add new feature` for branch `1-add-new-feature`.
16+
- The issue number should be the branch prefix, e.g., `feat: [#1] add new feature` for branch `1-add-new-feature`.
1517
- We use the proposed GitHub branch naming convention:
16-
- Starts with a number indicating the issue number.
17-
- Followed by a hyphen and a short description of the feature or fix.
18-
- Uses hyphens to separate words, e.g., `1-add-new-feature`.
18+
- Starts with a number indicating the issue number.
19+
- Followed by a hyphen and a short description of the feature or fix.
20+
- Uses hyphens to separate words, e.g., `1-add-new-feature`.
1921
- Ensure that shell scripts are POSIX-compliant.
2022
- Provide clear and concise documentation for any new features or changes.
2123
- Follow https://github.com/DavidAnson/markdownlint conventions for Markdown files.
24+
- Use https://github.com/koalaman/shellcheck for shell scripts to ensure they are free of common errors.

project-words.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ commoninit
88
dialout
99
dmacvicar
1010
dnsmasq
11+
domifaddr
1112
dominfo
13+
domstate
1214
ECDH
1315
ethernets
1416
fullchain

0 commit comments

Comments
 (0)