Skip to content

Commit 334ce8f

Browse files
chore: set up some templates/forms for future contributors
1 parent a47f813 commit 334ce8f

3 files changed

Lines changed: 133 additions & 0 deletions

File tree

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Bug report
2+
description: Report crashes or incorrect behaviour of existing functionality in QtNodes.
3+
type: Bug
4+
body:
5+
- type: textarea
6+
id: steps
7+
attributes:
8+
label: Description with steps to reproduce
9+
description: Please also describe the actual (current) and expected behaviour and include a code snippet where relevant
10+
placeholder: |
11+
1. go to ...
12+
2. then click on ...
13+
3. then ...
14+
Actual behaviour:
15+
Expected behaviour:
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: evidence
20+
attributes:
21+
label: Supporting files, videos and screenshots
22+
description: |
23+
* A short screen recording (ideally 20sec or less) or screenshot
24+
placeholder: |
25+
Click into this text box and paste your files, videos and screenshots here.
26+
validations:
27+
required: true
28+
- type: input
29+
id: qt_version
30+
attributes:
31+
label: Qt Version
32+
description: What version of Qt does this bug occur on?
33+
placeholder: Qt 5/6?
34+
validations:
35+
required: true
36+
- type: input
37+
id: os
38+
attributes:
39+
label: Operating system
40+
description: What OS does this bug occur on?
41+
placeholder: Windows 11, macOS 13, Ubuntu 22.04, etc.
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: context
46+
attributes:
47+
label: Additional context
48+
description: Further information which may be relevant to this bug
49+
50+
- type: checkboxes
51+
id: checklist
52+
attributes:
53+
label: Checklist
54+
description: "Before submitting your bug report, please make sure the following requirements are met:"
55+
options:
56+
- label: "I have verified that this issue has not been logged before, by searching the [issue tracker](https://github.com/paceholder/nodeeditor/issues) for similar issues"
57+
required: true
58+
- label: "I have attached all requested files and information to this report"
59+
required: true
60+
- label: "I have attempted to identify the root problem as concisely as possible, and have used minimal reproducible examples where possible"
61+
required: true
62+
- type: markdown
63+
attributes:
64+
value: If an issue does not meet these requirements, it may be closed without investigation.
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Feature request
2+
description: Request new functionality or enhancements.
3+
type: Feature
4+
body:
5+
- type: textarea
6+
id: idea
7+
attributes:
8+
label: Your idea
9+
description: Describe your idea in a few sentences.
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: whatfor
14+
attributes:
15+
label: Problem to be solved
16+
description: What problem would your idea solve?
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: other
21+
attributes:
22+
label: Prior art
23+
description: Have you run into this problem with other apps? How did they solve it? You can paste screenshots.
24+
validations:
25+
required: false
26+
- type: textarea
27+
id: context
28+
attributes:
29+
label: Additional context
30+
description: Anything else of note
31+
validations:
32+
required: false
33+
34+
- type: checkboxes
35+
id: checklist
36+
attributes:
37+
label: Checklist
38+
description: "Before submitting your bug report, please make sure the following requirements are met:"
39+
options:
40+
- label: "I have verified that this feature request has not been logged before, by searching the [issue tracker](https://github.com/paceholder/nodeeditor/issues) for similar requests"
41+
required: true
42+
- type: markdown
43+
attributes:
44+
value: If a feature request does not meet these requirements, it may be closed without investigation.

.github/pull_request_template.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## Type of change
2+
- [ ] Bug fix
3+
- [ ] New feature
4+
- [ ] Breaking change
5+
- [ ] Documentation/refactoring
6+
7+
## Description
8+
<!--
9+
Brief description of the change;
10+
If this is a breaking change, please describe what breaks and how to migrate
11+
-->
12+
13+
## Testing
14+
- Qt version tested:
15+
- [ ] Existing tests still pass
16+
- [ ] Added tests for new functionality (if applicable)
17+
18+
## Breaking changes?
19+
<!-- If yes, describe what breaks and how to migrate -->
20+
21+
## Related issue
22+
<!-- Link with "Fixes #123" or "Closes #123" if applicable -->
23+
24+
---
25+
*Please fill out the sections above to help reviewers understand your changes.*

0 commit comments

Comments
 (0)