Skip to content

Commit

Permalink
📝 docs(PR): Update GitHub PR generator prompt format
Browse files Browse the repository at this point in the history
  • Loading branch information
thibaultyou committed Sep 29, 2024
1 parent 1daa72c commit 40d2eec
Showing 1 changed file with 19 additions and 24 deletions.
43 changes: 19 additions & 24 deletions prompts/github_pull_request_generator/prompt.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

<pull_request>
<title>
Provide a clear and concise title for the pull request.
</title>
```markdown
# [Title]

<description>
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
</description>
- Known limitations or future work

<changes>
List the files changed and provide a brief explanation of each change.
</changes>
## Changes
[List of files changed and brief explanation of each change]

<documentation>
Include any necessary documentation updates or links to updated documentation.
</documentation>
## Documentation
[Any necessary documentation updates or links to updated documentation]

<labels_and_reviewers>
Suggest appropriate labels for the pull request and recommend reviewers if applicable.
</labels_and_reviewers>
## Labels and Reviewers
- Labels: [Suggested labels]
- Reviewers: [Recommended reviewers]

<additional_notes>
Include any additional information, such as related issues, dependencies, or deployment instructions.
</additional_notes>
</pull_request>
## Additional Notes
[Any additional information, such as related issues, dependencies, or deployment instructions]
```

Remember to:

Expand All @@ -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.

0 comments on commit 40d2eec

Please sign in to comment.