From fbd6b3a27878e401f73a068e401e637bbc1440dd Mon Sep 17 00:00:00 2001 From: Thibault YOU Date: Wed, 9 Oct 2024 12:06:38 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs(README):=20Add=20tip=20for?= =?UTF-8?q?=20prompt=20engineering=20category?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 9 +++++---- src/templates/main_readme.md | 2 ++ 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 09f2ba3..02d69c9 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # 📚 Prompt Library > ### 🚧 **Project Under Development** 🚧 -> > This project is evolving. You may encounter bugs or frequent changes. Your feedback and contributions are welcome! Welcome to the **Prompt Library**. This repository contains a collection of AI prompts categorized for easy navigation and reuse. @@ -10,15 +9,17 @@ Welcome to the **Prompt Library**. This repository contains a collection of AI p > **Note:** The prompts listed here serve as examples to demonstrate the structure and organization of this library. The primary goal is for you, the user, to create and maintain your own personalized library of prompts tailored to your specific needs and use cases. Feel free to modify, remove, or add prompts as you see fit. +> **Tip:** Check out the Prompt Engineering category in this library. It contains prompts that can help you create high-quality prompts with ease and get started in building your own prompt library. + ### Coding - [Code Refactoring Agent](prompts/code_refactoring_agent/README.md) - Analyzes, refactors, and validates code to improve quality, readability, and performance -- [Coding Assistant Agent](prompts/coding_assistant_agent/README.md) - Assists with code writing, analysis, optimization, and debugging across multiple languages - [Git Branch Name Generator](prompts/git_branch_name_generator/README.md) - Generates optimal git branch names based on project context and development workflow -- [Git Commit Message Expert](prompts/git_commit_message_agent/README.md) - Generates precise git commit messages following Conventional Commits specification - [GitHub Issue Creator Agent](prompts/github_issue_creator_agent/README.md) - Creates comprehensive, optimized GitHub issues based on project context and team dynamics -- [Software Developer Pull Request Generator](prompts/software_dev_pr_generator/README.md) - Generates comprehensive pull requests for software development projects +- [Git Commit Message Expert](prompts/git_commit_message_agent/README.md) - Generates precise git commit messages following Conventional Commits specification +- [Coding Assistant Agent](prompts/coding_assistant_agent/README.md) - Assists with code writing, analysis, optimization, and debugging across multiple languages - [Software Specification Agent](prompts/software_specification_agent/README.md) - Generates comprehensive software specifications through interactive requirements gathering +- [Software Developer Pull Request Generator](prompts/software_dev_pr_generator/README.md) - Generates comprehensive pull requests for software development projects ### Healthcare diff --git a/src/templates/main_readme.md b/src/templates/main_readme.md index a39e653..0d9d864 100644 --- a/src/templates/main_readme.md +++ b/src/templates/main_readme.md @@ -10,6 +10,8 @@ Welcome to the **Prompt Library**. This repository contains a collection of AI p > **Note:** The prompts listed here serve as examples to demonstrate the structure and organization of this library. The primary goal is for you, the user, to create and maintain your own personalized library of prompts tailored to your specific needs and use cases. Feel free to modify, remove, or add prompts as you see fit. +> **Tip:** Check out the Prompt Engineering category in this library. It contains prompts that can help you create high-quality prompts with ease and get started in building your own prompt library. + {%- for category, prompts in categories %} ### {{ format_category(category) }}