Come contribuire con prompt, codice e framework alla AI Prompt Library.

• Aggiungere Nuovi Prompt
• Formato dei File Prompt
• Categorie
• Aggiungere Framework al Generatore
• Aggiungere Comandi CLI
• Eseguire i Test
• Linee Guida sullo Stile del Codice
• Processo di Pull Request
• Segnalazione Bug
• Richieste di Funzionalità

Il modo più semplice per contribuire. Ogni prompt è un singolo file Markdown nella directory prompts/.

1. Scegli la categoria giusta — vedi Categorie di seguito
2. Crea il file — prompts/<category>/your-prompt-name.md
3. Aggiungi il frontmatter YAML — metadati all'inizio del file
4. Scrivi il contenuto — segui il Formato dei File Prompt
5. Esegui i test — node test/run.js (tutti i test devono passare)
6. Apri una pull request

# 1. Create the file
touch prompts/development/api-testing.md

# 2. Write the content (see format below)

# 3. Run tests
node test/run.js

# 4. The CLI picks it up automatically — no registration step
node bin/prompt-lib.js show api-testing

Ogni file prompt segue questa struttura:

---
title: Your Prompt Title
category: development
tags: [api, testing, quality, automation]
difficulty: intermediate
models: [claude, gpt-4, gemini]
---

# Your Prompt Title

## When to Use

Describe when this technique or template is most useful.
Include specific scenarios and use cases. Also mention when
NOT to use it — this helps users make better decisions.

## The Technique

Detailed explanation of the approach, methodology, or framework.
Include the reasoning behind why this works and any theory.

## Template

\```
You are a {{role}} specializing in {{domain}}.

TASK:
{{task_description}}

RULES:
- Rule 1
- Rule 2
- {{custom_constraint}}

OUTPUT FORMAT:
Respond in {{format}} with clear sections.

Before responding, verify that your answer is complete and accurate.
\```

## Examples

### Example 1: [Scenario Name]

**Input:**
\```
[Example input with filled placeholders]
\```

**Expected Output:**
\```
[Example of what the AI should produce]
\```

### Example 2: [Another Scenario]
...

## Tips

- Practical tip from real usage experience
- Common adjustment that improves results
- Model-specific advice (e.g., "Claude works best with XML tags here")

## Common Mistakes

- ❌ Mistake 1 — why it's wrong and how to fix it
- ❌ Mistake 2 — the impact and the correct approach
- ❌ Mistake 3 — a subtle pitfall that's easy to miss

• Inserisci il template in un blocco di codice recintato (```)
• Usa {{nome_segnaposto}} per i campi dinamici
• Usa underscore o trattini nei nomi dei segnaposto: {{task_description}}, {{output-format}}
• I segnaposto vengono rilevati automaticamente da findPlaceholders() usando la regex /\{\{[\w_\-\s/]+\}\}/g

Per creare una nuova categoria, basta creare una nuova sottodirectory in prompts/. La CLI scopre le categorie automaticamente dalla struttura delle directory.

I framework del generatore sono definiti in src/generator.js nell'oggetto FRAMEWORKS.

Modifica src/generator.js e aggiungi una nuova voce a FRAMEWORKS:

'my-framework': {
  name: 'My Framework',
  description: 'What it does in one sentence',
  questions: [
    {
      key: 'field1',
      label: 'Question for the user',
      required: true
    },
    {
      key: 'field2',
      label: 'Optional question',
      required: false,
      default: 'default value'
    },
  ],
  generate: (answers) => {
    return `You are an expert in ${answers.field1}.

TASK:
${answers.field2}

RULES:
- Be specific and actionable
- Show your reasoning

OUTPUT FORMAT:
Structured markdown with clear sections`;
  }
}

Il framework appare automaticamente in:

• CLI: prompt-lib generate
• Prompt Workshop: scheda Generate

I comandi CLI sono definiti in bin/prompt-lib.js.

1. Aggiungi un caso all'istruzione switch in main():

case 'mycommand': {
  // Your command logic here
  const arg = args[1];
  // ...
  break;
}

2. Aggiungi alla stringa HELP all'inizio del file:

const HELP = `
  ...
  Commands:
    ...
    mycommand <arg>       Description of what it does
  ...
`;

3. Aggiungi i test se il comando coinvolge nuovi moduli

• I comandi interattivi usano readline per l'input dell'utente
• Usa copyToClipboard(text) per la copia negli appunti
• Usa formatPromptDetail() ecc. da src/formatter.js per l'output
• Rispetta la variabile d'ambiente NO_COLOR (gestita da formatter.js)
• Esci con process.exit(1) in caso di errori

node test/run.js

La suite di test (test/run.js) esegue 46 test senza alcuna dipendenza. I test verificano:

# Before changes — establish baseline
node test/run.js

# Make your changes...

# After changes — verify nothing is broken
node test/run.js

Tutti i test devono passare prima di inviare una pull request.

Il progetto usa ES Modules (ESM). Usa la sintassi import/export:

// ✅ Correct
import { readFileSync } from 'fs';
export function myFunction() { ... }

// ❌ Wrong
const fs = require('fs');
module.exports = { myFunction };

Non aggiungere pacchetti npm. Usa solo moduli integrati di Node.js:

Questo è un principio di design fondamentale. La libreria funziona con un'installazione pulita di Node.js — nessun npm install necessario.

• Mantieni lo stile del codice esistente — osserva il codice vicino per i pattern
• Usa const per impostazione predefinita, let quando serve la riassegnazione
• Usa i template literal per l'interpolazione delle stringhe
• Usa nomi di variabili descrittivi
• Commenta solo quando il "perché" non è ovvio dal codice
• viewer.html è autonomo — tutti i dati dei prompt sono incorporati come JSON

1. Fai il fork del repository e crea un branch da main
2. Apporta le modifiche — segui le linee guida sopra
3. Esegui i test: node test/run.js — tutti i test devono passare
4. Apri una pull request con una descrizione chiara di cosa hai modificato e perché

• Mantieni le PR focalizzate — una funzionalità o correzione per PR
• Descrivi la modifica — cosa, perché e come testarla
• Includi esempi — se aggiungi un prompt, mostra un uso di esempio
• Non rompere il comportamento esistente — testa manualmente i comandi CLI: prompt-lib list, prompt-lib search, ecc.

Apri una issue con:

• Cosa ti aspettavi che accadesse
• Cosa è effettivamente accaduto
• Passaggi per riprodurre il problema
• Il tuo ambiente: versione Node.js, sistema operativo, browser (per problemi del Workshop)

Apri una issue descrivendo:

• Cosa vuoi fare
• Perché gli strumenti attuali non lo coprono
• Come ti aspetti che funzioni

Contribuendo, accetti che i tuoi contributi saranno licenziati sotto la Licenza MIT.

Navigazione: ← App Desktop  |  Home