Skip to content

Commit

Permalink
chore: add templates for PR & issues (#2)
Browse files Browse the repository at this point in the history
PR template

issue template for: bug, documentation, enhancement, question
  • Loading branch information
imrn99 authored Feb 7, 2024
1 parent eb18d44 commit c75c349
Show file tree
Hide file tree
Showing 5 changed files with 131 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Bug Report
about: Use this template to report a bug you encountered.
title: "Bug: Title"
labels: bug,
assignees:
---

# Description

## Information

- [ ] Crash
- [ ] Unexpected behavior (but no crash)
- [ ] Abnormal ressource usage

## Affected version or commit

...

## Log

### Observed behavior

Describe the problem.

If relevant, add crash log.

### Expected behavior

If relevant, describe the result you would expect.

## Minimal reproducible example

If the bug occurs during execution of a more complex program, this might be needed to better understand the problem. It might even show that the bug does not come from our tools and remove the need for this issue!
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/2-documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Documentation
about: Use this template to suggest documentation improvements or oversights.
title: "Doc: Title"
labels: documentation,
assignees:
---

# Description

## Information

- [ ] Improvements
- [ ] Additions
- [ ] Oversights
- [ ] Other: ...

## Where / What part ?

...

## Suggested / Wanted changes

...
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/3-enhancement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Enhancement / Suggestion
about: Use this template to suggest new feature or enhancement that could be integrated to the project.
title: "Enh: Title"
labels: enhancement/suggestion,
assignees:
---

# Description

## Information

- [ ] Enhancement of existing content
- [ ] Suggestion for a new feature
- [ ] Other: ...

## Suggested changes

### Current state

If relevant, add the affected part of the code.

### Proposal

...
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/9-question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: Question
about: Use this template to ask you question about the project.
title: "Que: Title"
labels: question,
assignees:
---

# Description


36 changes: 36 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Description

Summary of the changes if needed.

## Scope

- [ ] Code: if relevant, add affected target
- [ ] Build script: if relevant, add affected target
- [ ] Documentation
- [ ] CI
- [ ] Repository
- [ ] Other: ...

## Type of change

- [ ] New feature(s)
- [ ] Fix: if relevant, add issue #...
- [ ] Testing
- [ ] Refactor
- [ ] Revert
- [ ] Chore

## Other

- [ ] Breaking change
- [ ] New dependency

## Necessary follow-up

- [ ] Needs documentation
- [ ] Needs testing
- [ ] Other: ...

## Mentions

...

0 comments on commit c75c349

Please sign in to comment.