diff --git a/README.md b/README.md index abfdd85..a4e7387 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ Welcome to the **Prompt Library**. This repository contains a collection of AI p -- [GitHub Pull Request Generator](prompts/github_pull_request_generator/view.md) - Generates comprehensive and well-structured GitHub pull requests adhering to best practices +- [GitHub Pull Request Generator](prompts/github_pull_request_generator/view.md) - Generates comprehensive and well-structured GitHub pull requests based on change details and project context diff --git a/prompts/github_pull_request_generator/metadata.yml b/prompts/github_pull_request_generator/metadata.yml index 27f931c..72012fe 100644 --- a/prompts/github_pull_request_generator/metadata.yml +++ b/prompts/github_pull_request_generator/metadata.yml @@ -8,12 +8,12 @@ tags: - software_engineering - best_practices one_line_description: Generates comprehensive and well-structured GitHub pull requests - adhering to best practices -description: This prompt creates detailed GitHub pull requests based on provided change - details and project context. It generates a clear title, comprehensive description, - list of changes, documentation updates, and additional notes, ensuring high-quality - contributions that are easy to review and merge. + based on change details and project context +description: This prompt creates perfect GitHub pull requests by analyzing change + details and project context. It generates a formatted markdown output that includes + a clear title, detailed description, list of changes, documentation updates, and + additional notes, adhering to best practices and project standards. variables: - '{{CHANGE_DETAILS}}' - '{{PROJECT_CONTEXT}}' -content_hash: 3b22372d1f57cd40f383f3ea56f85c3d +content_hash: b6ad0e1be1aa1be5150cdfc15b876e7a diff --git a/prompts/github_pull_request_generator/prompt.md b/prompts/github_pull_request_generator/prompt.md index f65215e..682e121 100644 --- a/prompts/github_pull_request_generator/prompt.md +++ b/prompts/github_pull_request_generator/prompt.md @@ -27,38 +27,32 @@ To generate a perfect pull request, follow these steps: 7. Include any relevant links or references. 8. Ensure the pull request adheres to the project's coding standards and best practices. -Format your response as follows: +Format your response using GitHub-flavored markdown, ready for copy/pasting into a GitHub PR. Use the following structure: - - -Provide a clear and concise title for the pull request. - +```markdown +# [Title] - -Write a comprehensive description of the changes, including: +## Description +[Comprehensive description of the changes, including:] - Purpose of the changes - Impact on the project -- Any important implementation details +- Important implementation details - Testing performed -- Any known limitations or future work - +- Known limitations or future work - -List the files changed and provide a brief explanation of each change. - +## Changes +[List of files changed and brief explanation of each change] - -Include any necessary documentation updates or links to updated documentation. - +## Documentation +[Any necessary documentation updates or links to updated documentation] - -Suggest appropriate labels for the pull request and recommend reviewers if applicable. - +## Labels and Reviewers +- Labels: [Suggested labels] +- Reviewers: [Recommended reviewers] - -Include any additional information, such as related issues, dependencies, or deployment instructions. - - +## Additional Notes +[Any additional information, such as related issues, dependencies, or deployment instructions] +``` Remember to: @@ -67,5 +61,6 @@ Remember to: 3. Follow the project's specific guidelines and conventions. 4. Consider the perspective of both reviewers and future maintainers. 5. Highlight any areas that may need special attention or discussion. +6. Use appropriate markdown formatting, such as headers, lists, code blocks, and emphasis where needed. -Your goal is to create a pull request that is easy to review, understand, and merge, while maintaining high code quality and project standards. +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. diff --git a/prompts/github_pull_request_generator/view.md b/prompts/github_pull_request_generator/view.md index f28cf3b..6d11f47 100644 --- a/prompts/github_pull_request_generator/view.md +++ b/prompts/github_pull_request_generator/view.md @@ -21,11 +21,11 @@ ### ✏️ One-line Description -**Generates comprehensive and well-structured GitHub pull requests adhering to best practices** +**Generates comprehensive and well-structured GitHub pull requests based on change details and project context** ### 📄 Description -This prompt creates detailed GitHub pull requests based on provided change details and project context. It generates a clear title, comprehensive description, list of changes, documentation updates, and additional notes, ensuring high-quality contributions that are easy to review and merge. +This prompt creates perfect GitHub pull requests by analyzing change details and project context. It generates a formatted markdown output that includes a clear title, detailed description, list of changes, documentation updates, and additional notes, adhering to best practices and project standards. ### 🔧 Variables @@ -69,38 +69,32 @@ To generate a perfect pull request, follow these steps: 7. Include any relevant links or references. 8. Ensure the pull request adheres to the project's coding standards and best practices. -Format your response as follows: +Format your response using GitHub-flavored markdown, ready for copy/pasting into a GitHub PR. Use the following structure: - - -Provide a clear and concise title for the pull request. - +```markdown +# [Title] - -Write a comprehensive description of the changes, including: +## Description +[Comprehensive description of the changes, including:] - Purpose of the changes - Impact on the project -- Any important implementation details +- Important implementation details - Testing performed -- Any known limitations or future work - +- Known limitations or future work - -List the files changed and provide a brief explanation of each change. - +## Changes +[List of files changed and brief explanation of each change] - -Include any necessary documentation updates or links to updated documentation. - +## Documentation +[Any necessary documentation updates or links to updated documentation] - -Suggest appropriate labels for the pull request and recommend reviewers if applicable. - +## Labels and Reviewers +- Labels: [Suggested labels] +- Reviewers: [Recommended reviewers] - -Include any additional information, such as related issues, dependencies, or deployment instructions. - - +## Additional Notes +[Any additional information, such as related issues, dependencies, or deployment instructions] +``` Remember to: @@ -109,7 +103,8 @@ Remember to: 3. Follow the project's specific guidelines and conventions. 4. Consider the perspective of both reviewers and future maintainers. 5. Highlight any areas that may need special attention or discussion. +6. Use appropriate markdown formatting, such as headers, lists, code blocks, and emphasis where needed. -Your goal is to create a pull request that is easy to review, understand, and merge, while maintaining high code quality and project standards. +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