Codex Project Spec Template

Kategori

codex

Status

Guld

Bruges til

Denne prompt bruges som fast skabelon, når TuxCore skal lave en klar og komplet opgavebeskrivelse til Codex.

Den er især god til:

• PHP/MySQL projekter
• Docker Compose projekter
• OBS/StreamElements overlays
• Simply.com projekter
• TuxiNet.dk projekter
• GitHub/Gitea repositories
• Fejlrettelser med $patch
• Komplette builds med $full

Prompt

Du skal arbejde i dette projekt som en præcis og forsigtig kodeassistent.

## Opgave

[Beskriv præcist hvad der skal laves]

## Projektets formål

[Beskriv hvad systemet/projektet bruges til]

## Eksisterende struktur

[Indsæt relevant filstruktur, hvis den kendes]

Eksempel:

/project-root
├── index.php
├── config.php
├── assets/
│   ├── style.css
│   └── app.js
└── includes/
    └── db.php

## Vigtige regler

- Bevar eksisterende funktionalitet.
- Ret kun de filer der er nødvendige.
- Undgå unødvendige frameworks.
- Brug sikre standarder.
- Brug prepared statements ved databasekode.
- Brug tydelige fejlbeskeder, men læk ikke passwords, tokens eller serverhemmeligheder.
- Skriv kode der kan køre direkte i projektet.
- Hvis noget er uklart, lav en fornuftig antagelse og dokumentér den.
- Undgå store omskrivninger, medmindre det er nødvendigt.
- Gør løsningen copy/paste-klar.

## Teknisk miljø

- Sprog: [PHP/Python/JavaScript/etc.]
- Database: [MySQL/MariaDB/PostgreSQL/SQLite/ingen]
- Hosting: [Simply.com/Docker/LXC/Apache/Nginx/etc.]
- Repo: [GitHub/Gitea path hvis relevant]
- Domæne: [domæne hvis relevant]

## Krav

1. [Krav 1]
2. [Krav 2]
3. [Krav 3]

## Filer der sandsynligvis skal ændres

- [fil 1]
- [fil 2]
- [fil 3]

## Filer der ikke må ændres uden god grund

- [fil 1]
- [fil 2]

## Sikkerhed

- Ingen hardcodede adgangskoder.
- Ingen tokens i frontend.
- Valider input.
- Brug CSRF-beskyttelse ved forms, hvis relevant.
- Brug sessions sikkert, hvis login bruges.

## Acceptkriterier

Opgaven er færdig når:

- [ ] Funktionen virker som beskrevet.
- [ ] Eksisterende funktioner stadig virker.
- [ ] Koden er ryddelig og forståelig.
- [ ] Der er ingen kendte syntax-fejl.
- [ ] Eventuelle databaseændringer er dokumenteret.
- [ ] Der er angivet testtrin.

## Testtrin

Skriv præcise trin til at teste løsningen:

1. [Testtrin 1]
2. [Testtrin 2]
3. [Testtrin 3]

## Outputformat

Returnér:

1. Kort opsummering af ændringer.
2. Liste over ændrede filer.
3. Komplet kode for ændrede filer, hvis opgaven er `$full`.
4. Kun nødvendige patches, hvis opgaven er `$patch`.
5. Testkommandoer eller manuelle testtrin.

Eksempel på brug

$codex $patch

Jeg har et PHP-projekt på Simply.com, hvor login virker, men reset password sender ikke mail.
Find fejlen og ret kun det nødvendige.

Projektet bruger global PHPMailer her:
../vendor/autoload.php

Mail config ligger her:
../mail_config.php

Ret ikke designet.

Forventet output

Et godt Codex-output bør indeholde:

• Klar forståelse af opgaven
• Få og præcise filændringer
• Ingen unødvendig refaktorering
• Testbare ændringer
• Kort forklaring
• Eventuelle kommandoer/testtrin

Noter

• Denne template er lavet til Thomas/TuxCore-workflowet.
• Bruges når noget skal sendes videre til Codex.
• Kombinér gerne med $php, $docker, $obs, $debug, $full eller $patch.

Tags

codex, prompt, project-spec, tuxcore, patch, full, php, docker, obs, simply