forked from mufeedvh/code2prompt
-
Notifications
You must be signed in to change notification settings - Fork 0
/
write-github-pull-request.hbs
58 lines (46 loc) · 1.45 KB
/
write-github-pull-request.hbs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
Project Path: {{ absolute_code_path }}
I want you to generate a high-quality well-crafted Github pull request description for this project.
I will provide you with the source tree, git diff, git log, and pull request template.
Source Tree:
```
{{ source_tree }}
```
{{#if git_diff_branch}}
Git diff:
```
{{git_diff_branch}}
```
{{/if}}
{{#if git_log_branch}}
Git log:
```
{{git_log_branch}}
```
{{/if}}
The Pull Request description should include the following template and adhere best practice:
```
Title: provide with concise and informative title.
# What is this?
- Explain the motivation why this is needed and the expected outcome of implementing this.
- Write it in a humanized manner.
# Changes
- Provide list of key changes with good structure.
- Mention the class name, function name, and file name.
- Explain the code changes.
For example:
# Changes
## Added Features:
1. **New Functions in `file_name.`**:
- `function_name.`: code description.
## Code Changes:
1. **In `file_name.`**:
## Documentation Updates:
1. **In `file_name.`**:
# Demo
- N/A
# Context
- N/A
```
Please, analyze the git diff and git log to understand the changes. Do not output git log and git diff to the content.
Use your analysis of the code to generate accurate and helpful content, but also explain things clearly for users who may not be familiar with the implementation details.
Write the content in Markdown format and follow the provided pull request template.