Skip to content

Commit 1dd31b8

Browse files
authored
Merge pull request #114 from nbro/issue-100-templates
Add issues, pull request and release templates
2 parents 0576b5e + b98a477 commit 1dd31b8

File tree

4 files changed

+125
-0
lines changed

4 files changed

+125
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yml

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Bug Report
2+
3+
description: File a bug report
4+
5+
title: "[Bug]: "
6+
labels: ["bug"]
7+
projects: ["andz"]
8+
9+
assignees:
10+
- nbro
11+
12+
body:
13+
14+
- type: dropdown
15+
id: andz-version
16+
attributes:
17+
label: andz version
18+
description: Which andz version are you using?
19+
options:
20+
- "0.1.0"
21+
default: 0
22+
validations:
23+
required: true
24+
25+
- type: dropdown
26+
id: python-version
27+
attributes:
28+
label: Python version
29+
description: Which Python version are you using?
30+
options:
31+
- "3.9"
32+
- "3.10"
33+
- "3.11"
34+
- "3.12"
35+
default: 0
36+
validations:
37+
required: true
38+
39+
40+
- type: textarea
41+
id: bug-description
42+
attributes:
43+
label: Bug description
44+
description: What is the bug?
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: code
50+
attributes:
51+
label: Code
52+
description: Paste any relevant code
53+
render: python

.github/ISSUE_TEMPLATE/feature.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: New Feature
2+
3+
description: Suggest a new feature
4+
5+
title: "[Feature]: "
6+
labels: ["feature"]
7+
projects: ["andz"]
8+
9+
assignees:
10+
- nbro
11+
12+
body:
13+
14+
- type: dropdown
15+
id: feature-type
16+
attributes:
17+
label: Feature type
18+
description: Is the new feature an algorithm or a data structure?
19+
options:
20+
- Algorithm
21+
- Data structure
22+
default: 0
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: feature-description
28+
attributes:
29+
label: Feature description
30+
description: Describe the feature and why it should be implemented
31+
validations:
32+
required: true

.github/pull_request_template.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Pull Request
2+
3+
Closes #
4+
5+
<!--
6+
Use closes #X or fixes #X if this pull request closes or fixes issue number X.
7+
For more details, see
8+
https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.
9+
10+
Provide a brief description for this PR.
11+
12+
Provide more details, if the linked issue does not provide them or there is no linked issue.
13+
-->

.github/release.yml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
changelog:
2+
3+
categories:
4+
- title: Breaking Changes 🛠
5+
labels:
6+
- breaking
7+
- title: New Features 🎉
8+
labels:
9+
- feature
10+
- title: Algorithms
11+
labels:
12+
- algorithms
13+
- title: Data structures
14+
labels:
15+
- data-structures
16+
- title: Dependencies 📌
17+
labels:
18+
- dependencies
19+
- title: Testing ✅
20+
labels:
21+
- testing
22+
- title: Documentation 📖
23+
labels:
24+
- documentation
25+
- title: Other Changes
26+
labels:
27+
- "*"

0 commit comments

Comments
 (0)