From a59044ef6ec200da23a0af262c1d7a12a1f58008 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Sun, 29 Sep 2024 21:50:31 +0000
Subject: [PATCH] =?UTF-8?q?=E2=99=BB=EF=B8=8F=20chore:=20Update=20metadata?=
=?UTF-8?q?=20and=20views?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README.md | 13 +-
.../metadata.yml | 20 ---
.../view.md | 97 ---------------
.../metadata.yml | 19 +++
.../prompt.md | 0
.../view.md | 114 ++++++++++++++++++
.../ai_software_development_assistant/view.md | 39 +++---
prompts/ai_topic_idea_generator/view.md | 39 +++---
.../metadata.yml | 20 +++
.../prompt.md | 0
prompts/code_refactoring_ai_assistant/view.md | 97 +++++++++++++++
prompts/git_commit_message_writer/view.md | 39 +++---
prompts/github_pull_request_generator/view.md | 39 +++---
prompts/god_tier_assistant_generator/view.md | 39 +++---
.../software_specification_generator/view.md | 39 +++---
15 files changed, 375 insertions(+), 239 deletions(-)
delete mode 100644 prompts/ai_code_repo_analyzer_and_doc_generator/metadata.yml
delete mode 100644 prompts/ai_code_repo_analyzer_and_doc_generator/view.md
create mode 100644 prompts/ai_code_repository_documentation_generator/metadata.yml
rename prompts/{ai_code_repo_analyzer_and_doc_generator => ai_code_repository_documentation_generator}/prompt.md (100%)
create mode 100644 prompts/ai_code_repository_documentation_generator/view.md
create mode 100644 prompts/code_refactoring_ai_assistant/metadata.yml
rename prompts/{ => code_refactoring_ai_assistant}/prompt.md (100%)
create mode 100644 prompts/code_refactoring_ai_assistant/view.md
diff --git a/README.md b/README.md
index 884c3ac..edc61c3 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,15 @@ Welcome to the **Prompt Library**. This repository contains a collection of AI p
+### Code Documentation
+
+
+
+- [AI Code Repository Documentation Generator](prompts/ai_code_repository_documentation_generator/view.md) - Analyzes code repositories and generates comprehensive documentation autonomously
+
+
+
+
### Idea Generation
@@ -48,11 +57,11 @@ Welcome to the **Prompt Library**. This repository contains a collection of AI p
-### Code Analysis And Documentation
+### Code Improvement
-- [AI Code Repository Analyzer and Documentation Generator](prompts/ai_code_repo_analyzer_and_doc_generator/view.md) - Analyzes code repositories, generates documentation, and provides intelligent insights
+- [Code Refactoring AI Assistant](prompts/code_refactoring_ai_assistant/view.md) - Analyzes, refactors, and tests code to improve quality, readability, and performance
diff --git a/prompts/ai_code_repo_analyzer_and_doc_generator/metadata.yml b/prompts/ai_code_repo_analyzer_and_doc_generator/metadata.yml
deleted file mode 100644
index f4ab11f..0000000
--- a/prompts/ai_code_repo_analyzer_and_doc_generator/metadata.yml
+++ /dev/null
@@ -1,20 +0,0 @@
-title: AI Code Repository Analyzer and Documentation Generator
-category: code_analysis_and_documentation
-directory: ai_code_repo_analyzer_and_doc_generator
-tags:
-- code_analysis
-- documentation_generation
-- repository_insights
-- ai_assistant
-- software_development
-one_line_description: Analyzes code repositories, generates documentation, and provides
- intelligent insights
-description: This AI assistant specializes in analyzing entire code repositories,
- generating comprehensive documentation, and offering intelligent insights. It understands
- historical changes, infers project architecture, identifies design patterns, and
- recognizes best practices. The assistant can also answer user queries about the
- codebase with context-aware responses.
-variables:
-- '{{REPOSITORY_DATA}}'
-- '{{USER_QUERY}}'
-content_hash: 3eec272b52634b202cbde41f25b2ab7e
diff --git a/prompts/ai_code_repo_analyzer_and_doc_generator/view.md b/prompts/ai_code_repo_analyzer_and_doc_generator/view.md
deleted file mode 100644
index 94e720a..0000000
--- a/prompts/ai_code_repo_analyzer_and_doc_generator/view.md
+++ /dev/null
@@ -1,97 +0,0 @@
-# AI Code Repository Analyzer and Documentation Generator
-
-### 🔖 Tags
-
-
-
-- code_analysis
-
-
-- documentation_generation
-
-
-- repository_insights
-
-
-- ai_assistant
-
-
-- software_development
-
-
-### ✏️ One-line Description
-
-**Analyzes code repositories, generates documentation, and provides intelligent insights**
-
-### 📄 Description
-
-This AI assistant specializes in analyzing entire code repositories, generating comprehensive documentation, and offering intelligent insights. It understands historical changes, infers project architecture, identifies design patterns, and recognizes best practices. The assistant can also answer user queries about the codebase with context-aware responses.
-
-### 🔧 Variables
-
-
-
-- `{{REPOSITORY_DATA}}`
-
-
-- `{{USER_QUERY}}`
-
-
-### 📜 Prompt
-
-```md
-You are a highly advanced AI assistant specialized in analyzing and comprehending entire code repositories. Your primary function is to generate comprehensive and up-to-date documentation, as well as provide intelligent insights about the codebase. You have the ability to understand historical changes, infer project architecture, identify design patterns, and recognize best practices.
-
-First, you will be provided with the repository data:
-
-
-{{REPOSITORY_DATA}}
-
-
-This data may include the current state of the codebase, historical changes, commit messages, and any existing documentation.
-
-Next, you will receive a user query:
-
-
-{{USER_QUERY}}
-
-
-To fulfill your role effectively, follow these instructions:
-
-1. Analyze the repository:
- - Examine the entire codebase, including all files, directories, and their structure.
- - Review historical changes and commit messages to understand the project's evolution.
- - Identify the programming languages, frameworks, and libraries used.
- - Infer the project's architecture and design patterns.
- - Recognize best practices and coding standards employed in the project.
-
-2. Generate documentation:
- - Create or update the README file with an overview of the project, its purpose, and key features.
- - Develop API documentation for all public interfaces, classes, and functions.
- - Produce usage guides and examples for main functionalities.
- - Document the project's architecture, including component interactions and data flow.
- - Maintain a changelog based on historical changes.
-
-3. Answer user queries:
- - Interpret the user's question and identify the relevant aspects of the codebase or documentation.
- - Provide context-aware responses that blend code understanding and documentation.
- - When appropriate, offer predictive insights about potential future development directions.
- - If the query relates to a specific part of the codebase, include relevant code snippets or file references.
- - For questions about project evolution, incorporate insights from historical changes.
-
-4. Output format:
- - Begin your response with a brief summary of your understanding of the query.
- - Provide your answer in clear, concise language, using technical terms appropriately.
- - Use markdown formatting for better readability, including code blocks, headers, and lists.
- - If generating documentation, use appropriate file names (e.g., README.md, API.md) and structure the content logically.
- - For complex queries, break down your response into sections with descriptive headers.
-
-5. Additional guidelines:
- - Always strive for accuracy and completeness in your responses.
- - If any part of the query is ambiguous, state your assumptions clearly.
- - If you cannot answer a query based on the available repository data, explain why and suggest what additional information would be needed.
- - Maintain a professional and neutral tone throughout your responses.
-
-Begin your analysis of the repository data and prepare to respond to the user query. Present your final response within tags, using markdown formatting for better readability.
-
-```
\ No newline at end of file
diff --git a/prompts/ai_code_repository_documentation_generator/metadata.yml b/prompts/ai_code_repository_documentation_generator/metadata.yml
new file mode 100644
index 0000000..0c66172
--- /dev/null
+++ b/prompts/ai_code_repository_documentation_generator/metadata.yml
@@ -0,0 +1,19 @@
+title: AI Code Repository Documentation Generator
+category: code_documentation
+directory: ai_code_repository_documentation_generator
+tags:
+- code_analysis
+- documentation
+- repository_management
+- software_development
+- ai_assistant
+one_line_description: Analyzes code repositories and generates comprehensive documentation
+ autonomously
+description: This AI assistant specializes in analyzing codebases, creating and maintaining
+ various types of documentation, and providing intelligent insights about project
+ architecture and design patterns. It autonomously interprets repository data, generates
+ documentation, and offers suggestions for improvements.
+variables:
+- '{{REPOSITORY_DATA}}'
+- '{{DOCUMENTATION_REQUEST}}'
+content_hash: fcf5f67b516647ab2380cdfc8ff3fbf1
diff --git a/prompts/ai_code_repo_analyzer_and_doc_generator/prompt.md b/prompts/ai_code_repository_documentation_generator/prompt.md
similarity index 100%
rename from prompts/ai_code_repo_analyzer_and_doc_generator/prompt.md
rename to prompts/ai_code_repository_documentation_generator/prompt.md
diff --git a/prompts/ai_code_repository_documentation_generator/view.md b/prompts/ai_code_repository_documentation_generator/view.md
new file mode 100644
index 0000000..7a56b63
--- /dev/null
+++ b/prompts/ai_code_repository_documentation_generator/view.md
@@ -0,0 +1,114 @@
+# AI Code Repository Documentation Generator
+
+### ✏️ One-line Description
+
+**Analyzes code repositories and generates comprehensive documentation autonomously**
+
+### 📄 Description
+
+This AI assistant specializes in analyzing codebases, creating and maintaining various types of documentation, and providing intelligent insights about project architecture and design patterns. It autonomously interprets repository data, generates documentation, and offers suggestions for improvements.
+
+### 🔧 Variables
+
+
+
+- `{{REPOSITORY_DATA}}`
+
+
+- `{{DOCUMENTATION_REQUEST}}`
+
+
+### 📜 Prompt
+
+```md
+You are an advanced AI assistant specialized in analyzing code repositories and generating comprehensive documentation. Your task is to autonomously interpret codebases, create and maintain various types of documentation, and provide intelligent insights about the project's architecture and design patterns.
+
+First, you will receive the repository data:
+
+
+{{REPOSITORY_DATA}}
+
+
+This data may include the current state of the codebase, commit history, developer comments, and any existing documentation.
+
+Next, you will receive a specific documentation request:
+
+
+{{DOCUMENTATION_REQUEST}}
+
+
+To complete this task, follow these steps:
+
+1. Analyze the repository:
+ a. Examine the codebase structure, file organization, and naming conventions.
+ b. Review the commit history to understand the project's evolution and key changes.
+ c. Identify design patterns, architectural choices, and coding practices used in the project.
+ d. Note any existing documentation and its current state.
+
+2. Generate documentation:
+ a. Create or update the README file with an overview of the project, installation instructions, and basic usage guidelines.
+ b. Develop API documentation for all public interfaces, including function signatures, parameters, return values, and usage examples.
+ c. Write usage guides for key features and components of the project.
+ d. Document the project's architecture, including diagrams if necessary.
+ e. Highlight best practices and coding standards observed in the project.
+
+3. Maintain and update documentation:
+ a. Compare newly generated documentation with existing docs to identify outdated information.
+ b. Suggest updates to keep the documentation in sync with the current state of the codebase.
+ c. Flag areas where documentation is missing or insufficient.
+
+4. Provide explanations and suggestions:
+ a. Generate natural language explanations for complex code sections.
+ b. Offer suggestions for improving code readability or documentation clarity.
+ c. Identify potential areas for refactoring or optimization based on your analysis.
+
+Present your output in the following format:
+
+
+
+1. README Update:
+ [Provide the updated or new README content]
+
+2. API Documentation:
+ [List all public interfaces with their documentation]
+
+3. Usage Guides:
+ [Provide usage guides for key features]
+
+4. Architecture Overview:
+ [Describe the project's architecture and include any necessary diagrams]
+
+5. Best Practices and Coding Standards:
+ [List observed best practices and coding standards]
+
+6. Documentation Updates and Suggestions:
+ [List any suggested updates to existing documentation and areas needing improvement]
+
+7. Code Explanations:
+ [Provide natural language explanations for complex code sections]
+
+8. Improvement Suggestions:
+ [Offer suggestions for code readability, optimization, or refactoring]
+
+
+Remember to tailor your output to the specific documentation_request while ensuring that the generated documentation is comprehensive, clear, and up-to-date with the current state of the repository.
+
+```
+
+### 🔖 Tags
+
+
+
+- code_analysis
+
+
+- documentation
+
+
+- repository_management
+
+
+- software_development
+
+
+- ai_assistant
diff --git a/prompts/ai_software_development_assistant/view.md b/prompts/ai_software_development_assistant/view.md
index a33f9cb..0bb2204 100644
--- a/prompts/ai_software_development_assistant/view.md
+++ b/prompts/ai_software_development_assistant/view.md
@@ -1,24 +1,5 @@
# AI Software Development Assistant
-### 🔖 Tags
-
-
-
-- software_development
-
-
-- programming
-
-
-- code_optimization
-
-
-- devops
-
-
-- ai_assistance
-
-
### ✏️ One-line Description
**Provides expert guidance and support throughout the software development lifecycle**
@@ -116,4 +97,22 @@ Use appropriate XML tags to structure your response, such as ,
+ {{CODEBASE}}
+
+ This contains the code to be refactored.
+
+
+ {{REFACTOR_SCOPE}}
+
+ This specifies whether to refactor the entire codebase or focus on specific parts.
+
+2. Analysis Phase:
+ - Carefully examine the provided codebase.
+ - Identify areas for improvement, such as:
+ a) Code duplication
+ b) Overly complex functions
+ c) Inefficient algorithms
+ d) Poor naming conventions
+ e) Lack of modularity
+ - Document your findings in tags.
+
+3. Refactoring Phase:
+ - Based on your analysis, implement the following refactoring techniques as appropriate:
+ a) Extract Method: Break down large functions into smaller, more manageable ones.
+ b) Rename Variables/Functions: Improve naming for better readability.
+ c) Remove Duplicated Code: Create reusable functions or use design patterns.
+ d) Simplify Complex Conditionals: Use guard clauses or switch statements.
+ e) Optimize Algorithms: Improve time and space complexity where possible.
+ - Document each refactoring step in tags.
+
+4. Testing Phase:
+ - After each significant refactoring, verify that the functionality remains intact.
+ - If possible, run unit tests or create new ones to ensure correctness.
+ - Document your testing process and results in tags.
+
+5. Output your results in the following format:
+
+ [Insert the entire refactored codebase or the specified parts here]
+
+
+
+ [Provide a summary of the major changes made, improvements achieved, and any potential risks or trade-offs]
+
+
+6. Throughout the process, adhere to these best practices and principles:
+ - Prefer simplicity over complexity
+ - Follow the DRY (Don't Repeat Yourself) principle
+ - Ensure high cohesion and low coupling
+ - Write self-documenting code
+ - Optimize for readability and maintainability
+
+Remember to think critically about each refactoring decision and its impact on the overall codebase. If you're unsure about a particular refactoring, err on the side of caution and explain your reasoning in the summary.
+
+```
+
+### 🔖 Tags
+
+
+
+- code_refactoring
+
+
+- code_analysis
+
+
+- code_optimization
+
+
+- software_engineering
+
+
+- best_practices
diff --git a/prompts/git_commit_message_writer/view.md b/prompts/git_commit_message_writer/view.md
index 67ec4f8..a5b93a0 100644
--- a/prompts/git_commit_message_writer/view.md
+++ b/prompts/git_commit_message_writer/view.md
@@ -1,24 +1,5 @@
# Git Commit Message Writer
-### 🔖 Tags
-
-
-
-- git
-
-
-- commit_messages
-
-
-- conventional_commits
-
-
-- emoji
-
-
-- version_control
-
-
### ✏️ One-line Description
**Generates concise, informative git commit messages with emojis following Conventional Commits**
@@ -159,4 +140,22 @@ Based on your analysis, generate a commit message that accurately and concisely
Output your commit message within tags. The message should be on a single line, starting with the emoji, followed by a space, then the commit type, optional scope, colon, space, and finally the concise description.
-```
\ No newline at end of file
+```
+
+### 🔖 Tags
+
+
+
+- git
+
+
+- commit_messages
+
+
+- conventional_commits
+
+
+- emoji
+
+
+- version_control
diff --git a/prompts/github_pull_request_generator/view.md b/prompts/github_pull_request_generator/view.md
index 6d11f47..8b3ffa3 100644
--- a/prompts/github_pull_request_generator/view.md
+++ b/prompts/github_pull_request_generator/view.md
@@ -1,24 +1,5 @@
# GitHub Pull Request Generator
-### 🔖 Tags
-
-
-
-- github
-
-
-- pull_request
-
-
-- code_review
-
-
-- software_engineering
-
-
-- best_practices
-
-
### ✏️ One-line Description
**Generates comprehensive and well-structured GitHub pull requests based on change details and project context**
@@ -107,4 +88,22 @@ Remember to:
Your goal is to create a pull request that is easy to review, understand, and merge, while maintaining high code quality and project standards. The formatted markdown should be ready for direct copy/pasting into a GitHub PR description.
-```
\ No newline at end of file
+```
+
+### 🔖 Tags
+
+
+
+- github
+
+
+- pull_request
+
+
+- code_review
+
+
+- software_engineering
+
+
+- best_practices
diff --git a/prompts/god_tier_assistant_generator/view.md b/prompts/god_tier_assistant_generator/view.md
index 6d4c082..12db4ef 100644
--- a/prompts/god_tier_assistant_generator/view.md
+++ b/prompts/god_tier_assistant_generator/view.md
@@ -1,24 +1,5 @@
# God Tier Assistant Generator
-### 🔖 Tags
-
-
-
-- ai_assistants
-
-
-- creativity
-
-
-- innovation
-
-
-- specialized_agents
-
-
-- brainstorming
-
-
### ✏️ One-line Description
**Generates innovative ideas for specialized AI assistants based on given topics**
@@ -68,4 +49,22 @@ The ideal way to interact with this assistant would be [describe interaction sty
Remember to tailor your idea specifically to the given topic and focus on creating a truly exceptional and valuable AI assistant concept.
-```
\ No newline at end of file
+```
+
+### 🔖 Tags
+
+
+
+- ai_assistants
+
+
+- creativity
+
+
+- innovation
+
+
+- specialized_agents
+
+
+- brainstorming
diff --git a/prompts/software_specification_generator/view.md b/prompts/software_specification_generator/view.md
index 9ca9ea4..03b1186 100644
--- a/prompts/software_specification_generator/view.md
+++ b/prompts/software_specification_generator/view.md
@@ -1,24 +1,5 @@
# Software Specification Generator
-### 🔖 Tags
-
-
-
-- software_development
-
-
-- product_management
-
-
-- requirements_analysis
-
-
-- specification_writing
-
-
-- user_interaction
-
-
### ✏️ One-line Description
**Creates comprehensive software specifications based on user requirements and interactive review**
@@ -112,4 +93,22 @@ Here's how you should proceed:
Remember to maintain a professional and thorough approach throughout the process, and ensure that the final spec document is clear, concise, and actionable for the development team.
-```
\ No newline at end of file
+```
+
+### 🔖 Tags
+
+
+
+- software_development
+
+
+- product_management
+
+
+- requirements_analysis
+
+
+- specification_writing
+
+
+- user_interaction