Skip to content

Commit

Permalink
chore: add github templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jgazeau committed Aug 2, 2022
1 parent 3031485 commit 7b9ab90
Show file tree
Hide file tree
Showing 5 changed files with 82 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Feature
description: Request a new feature
title: "[feature_request]: "
labels: ["enhancement"]
body:
- type: textarea
id: request
attributes:
label: What is missing in the project?
description: Please provide what is missing in the project and why it should be added?
validations:
required: true
- type: textarea
id: solution
attributes:
label: Solution?
description: Got a solution, or an idea to implement the feature? Feel free to provide it!
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Bug Report
description: Create a bug report
title: "[bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
# What is the issue?
---
*Please provide as much information as you can in this bug report!*
*Also remember to provide a reproducer if possible, it will make it easier and quicker to help you 😉*
- type: textarea
id: issue-steps
attributes:
label: Steps that lead to the issue
description: Please provide all the steps and relevant information that lead to your issue (logs, screenshots, versions, ...).
validations:
required: true
- type: textarea
id: issue-expected-behavior
attributes:
label: Expected behavior
description: What did you expect to happen?
validations:
required: true
- type: textarea
id: issue-reproducer
attributes:
label: Reproducer
description: Provide a reproducer so we can easily and quickly help you.
validations:
required: true
- type: textarea
id: solution
attributes:
label: Solution?
description: Got a solution, or an idea to solve the issue? Feel free to provide it!
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Question
description: Ask a question related to the project
title: "[question]: "
labels: ["question"]
body:
- type: textarea
id: question
attributes:
label: Question?
description: Feel free to ask any question regarding the project.
validations:
required: true
14 changes: 14 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Description

Please provide a summary of the change, including context of this PR and link to the appropriate issue(s) if any.

Fixes #<ISSUE_NUMBER>

# PR checklist:

- [ ] Code follows the code style schemes of the project
- [ ] Code is tested
- [ ] Code quality is at least even, ideally greater
- [ ] Code commits are following the [Conventional Commits](https://www.conventionalcommits.org/) specification
- [ ] Documentation is up-to-date (code comments, project documentation, ...)
- [ ] All tests passed successfully

0 comments on commit 7b9ab90

Please sign in to comment.