You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 10, 2025. It is now read-only.
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
Copy file name to clipboardExpand all lines: .github/copilot-instructions.md
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,19 +3,22 @@ This repository contains all the configuration needed to run the live Torrust Tr
3
3
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.
4
4
5
5
The current major initiative is to migrate the tracker to a new infrastructure on Hetzner. This involves:
6
+
6
7
- Running the tracker binary directly on the host for performance.
7
8
- Using Docker for supporting services like Nginx, Prometheus, Grafana and MySQL.
8
9
- Migrating the database from SQLite to MySQL.
9
10
10
11
When providing assistance, please act as an experienced open-source developer and system administrator.
11
12
12
13
Follow these conventions:
14
+
13
15
- 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`.
15
17
- 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`.
19
21
- Ensure that shell scripts are POSIX-compliant.
20
22
- Provide clear and concise documentation for any new features or changes.
21
23
- 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.
0 commit comments