Comment contribuer des prompts, du code et des frameworks à l'AI Prompt Library.

• Ajouter de Nouveaux Prompts
• Format des Fichiers Prompt
• Catégories
• Ajouter des Frameworks au Générateur
• Ajouter des Commandes CLI
• Exécuter les Tests
• Conventions de Style de Code
• Processus de Pull Request
• Signalement de Bugs
• Demandes de Fonctionnalités

C'est la manière la plus simple de contribuer. Chaque prompt est un fichier Markdown unique dans le répertoire prompts/.

1. Choisissez la bonne catégorie — voir Catégories ci-dessous
2. Créez le fichier — prompts/<category>/your-prompt-name.md
3. Ajoutez le frontmatter YAML — les métadonnées en début de fichier
4. Rédigez le contenu — suivez le Format des Fichiers Prompt
5. Exécutez les tests — node test/run.js (tous les tests doivent passer)
6. Ouvrez une 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

Chaque fichier prompt suit cette structure :

---
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

• Placez le template dans un bloc de code délimité (```)
• Utilisez {{nom_du_champ}} pour les champs dynamiques
• Utilisez des underscores ou des tirets dans les noms de champs : {{task_description}}, {{output-format}}
• Les champs sont détectés automatiquement par findPlaceholders() via la regex /\{\{[\w_\-\s/]+\}\}/g

Pour créer une nouvelle catégorie, il suffit de créer un nouveau sous-répertoire dans prompts/. La CLI découvre les catégories automatiquement grâce à la structure des répertoires.

Les frameworks du générateur sont définis dans src/generator.js dans l'objet FRAMEWORKS.

Modifiez src/generator.js et ajoutez une nouvelle entrée à 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`;
  }
}

Le framework apparaît automatiquement dans :

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

Les commandes CLI sont définies dans bin/prompt-lib.js.

1. Ajoutez un cas dans l'instruction switch de main() :

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

2. Ajoutez à la chaîne HELP en haut du fichier :

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

3. Ajoutez des tests si la commande implique de nouveaux modules

• Les commandes interactives utilisent readline pour l'entrée utilisateur
• Utilisez copyToClipboard(text) pour la copie dans le presse-papiers
• Utilisez formatPromptDetail() etc. de src/formatter.js pour la sortie
• Respectez la variable d'environnement NO_COLOR (gérée par formatter.js)
• Quittez avec process.exit(1) en cas d'erreur

node test/run.js

La suite de tests (test/run.js) exécute 46 tests sans aucune dépendance. Les tests vérifient :

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

# Make your changes...

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

Tous les tests doivent passer avant de soumettre une pull request.

Le projet utilise les ES Modules (ESM). Utilisez la syntaxe import/export :

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

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

N'ajoutez aucun paquet npm. Utilisez uniquement les modules intégrés de Node.js :

C'est un principe de design fondamental. La bibliothèque fonctionne avec une installation vierge de Node.js — aucun npm install nécessaire.

• Respectez le style de code existant — observez le code voisin pour les conventions
• Utilisez const par défaut, let uniquement quand une réaffectation est nécessaire
• Utilisez les template literals pour l'interpolation de chaînes
• Utilisez des noms de variables descriptifs
• Commentez seulement quand le « pourquoi » n'est pas évident dans le code
• viewer.html est autonome — toutes les données des prompts sont intégrées en JSON

1. Forkez le dépôt et créez une branche à partir de main
2. Apportez vos modifications — suivez les conventions ci-dessus
3. Exécutez les tests : node test/run.js — tous les tests doivent passer
4. Ouvrez une pull request avec une description claire de ce que vous avez modifié et pourquoi

• Gardez les PR ciblées — une fonctionnalité ou correction par PR
• Décrivez la modification — quoi, pourquoi et comment la tester
• Incluez des exemples — si vous ajoutez un prompt, montrez un cas d'utilisation
• Ne cassez pas le comportement existant — testez manuellement les commandes CLI : prompt-lib list, prompt-lib search, etc.

Ouvrez une issue en incluant :

• Ce que vous attendiez qu'il se passe
• Ce qui s'est réellement passé
• Les étapes pour reproduire le problème
• Votre environnement : version de Node.js, système d'exploitation, navigateur (pour les problèmes du Workshop)

Ouvrez une issue en décrivant :

• Ce que vous souhaitez faire
• Pourquoi les outils actuels ne répondent pas à ce besoin
• Comment vous attendez que cela fonctionne

En contribuant, vous acceptez que vos contributions soient licenciées sous la Licence MIT.

Navigation : ← Applications Desktop  |  Accueil