A fork of https://github.com/crosspoint-reader/crosspoint-reader
Add Github templates
Added Github templates for PRs and bugs
Also added one for funding, please do not feel obligated to
donate to the project, this is not a for-profit endevour, I
just had someone ask where they could send a few dollars so
I have set it up
+65
+54
.github/ISSUE_TEMPLATE/bug_report.yml
+54
.github/ISSUE_TEMPLATE/bug_report.yml
···
1
+
name: Bug Report
2
+
description: Report an issue or unexpected behavior
3
+
title: "Short, descriptive title of the issue"
4
+
labels: ["bug", "triage"]
5
+
body:
6
+
- type: markdown
7
+
attributes:
8
+
value: |
9
+
Thanks for taking the time to report this bug! Please fill out the details below.
10
+
11
+
- type: input
12
+
id: version
13
+
attributes:
14
+
label: Affected Version
15
+
description: What version of the project/library are you using? (e.g., v1.2.3, master branch commit SHA)
16
+
placeholder: Ex. v1.2.3
17
+
validations:
18
+
required: true
19
+
20
+
- type: textarea
21
+
id: bug-description
22
+
attributes:
23
+
label: Describe the Bug
24
+
description: A clear and concise description of what the bug is.
25
+
placeholder:
26
+
validations:
27
+
required: true
28
+
29
+
- type: textarea
30
+
id: steps-to-reproduce
31
+
attributes:
32
+
label: Steps to Reproduce
33
+
description: Clearly list the steps necessary to reproduce the unexpected behavior.
34
+
placeholder: |
35
+
1. Go to '...'
36
+
2. Select '...'
37
+
3. Crash
38
+
validations:
39
+
required: true
40
+
41
+
- type: textarea
42
+
id: expected-behavior
43
+
attributes:
44
+
label: Expected Behavior
45
+
description: A clear and concise description of what you expected to happen.
46
+
validations:
47
+
required: true
48
+
49
+
- type: textarea
50
+
id: logs
51
+
attributes:
52
+
label: Relevant Log Output/Screenshots
53
+
description: If applicable, error messages, or log output to help explain your problem. You can drag and drop images here.
54
+
render: shell
+9
.github/PULL_REQUEST_TEMPLATE.md
+9
.github/PULL_REQUEST_TEMPLATE.md
···
1
+
## Summary
2
+
3
+
* **What is the goal of this PR?** (e.g., Fixes a bug in the user authentication module, Implements the new feature for
4
+
file uploading.)
5
+
* **What changes are included?**
6
+
7
+
## Additional Context
8
+
9
+
* Add any other information that might be helpful for the reviewer (e.g., performance implications, potential risks, specific areas to focus on).