Skip to content

Commit

Permalink
Merge pull request #114 from nbro/issue-100-templates
Browse files Browse the repository at this point in the history
Add issues, pull request and release templates
  • Loading branch information
nbro authored Mar 24, 2024
2 parents 0576b5e + b98a477 commit 1dd31b8
Show file tree
Hide file tree
Showing 4 changed files with 125 additions and 0 deletions.
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Bug Report

description: File a bug report

title: "[Bug]: "
labels: ["bug"]
projects: ["andz"]

assignees:
- nbro

body:

- type: dropdown
id: andz-version
attributes:
label: andz version
description: Which andz version are you using?
options:
- "0.1.0"
default: 0
validations:
required: true

- type: dropdown
id: python-version
attributes:
label: Python version
description: Which Python version are you using?
options:
- "3.9"
- "3.10"
- "3.11"
- "3.12"
default: 0
validations:
required: true


- type: textarea
id: bug-description
attributes:
label: Bug description
description: What is the bug?
validations:
required: true

- type: textarea
id: code
attributes:
label: Code
description: Paste any relevant code
render: python
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: New Feature

description: Suggest a new feature

title: "[Feature]: "
labels: ["feature"]
projects: ["andz"]

assignees:
- nbro

body:

- type: dropdown
id: feature-type
attributes:
label: Feature type
description: Is the new feature an algorithm or a data structure?
options:
- Algorithm
- Data structure
default: 0
validations:
required: true

- type: textarea
id: feature-description
attributes:
label: Feature description
description: Describe the feature and why it should be implemented
validations:
required: true
13 changes: 13 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Pull Request

Closes #

<!--
Use closes #X or fixes #X if this pull request closes or fixes issue number X.
For more details, see
https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.
Provide a brief description for this PR.
Provide more details, if the linked issue does not provide them or there is no linked issue.
-->
27 changes: 27 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
changelog:

categories:
- title: Breaking Changes 🛠
labels:
- breaking
- title: New Features 🎉
labels:
- feature
- title: Algorithms
labels:
- algorithms
- title: Data structures
labels:
- data-structures
- title: Dependencies 📌
labels:
- dependencies
- title: Testing ✅
labels:
- testing
- title: Documentation 📖
labels:
- documentation
- title: Other Changes
labels:
- "*"

0 comments on commit 1dd31b8

Please sign in to comment.