Skip to content

Commit

Permalink
Basic issue and pr templates (#45)
Browse files Browse the repository at this point in the history
## Description of changes

<!-- What changes did you make -->
Add issue and pr templates

The bug template is based on nixpkgs bug template

## Relevant Issues

<!-- Eg. #43 -->
#42
  • Loading branch information
IogaMaster committed Sep 27, 2023
1 parent 07ff8df commit baccee1
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 0 deletions.
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: 'bug'
assignees: ''
---

### Describe the bug
A clear and concise description of what the bug is.

### Steps To Reproduce
Steps to reproduce the behavior:
1. ...
2. ...
3. ...

### Expected behavior
A clear and concise description of what you expected to happen.


### Environment

Please run `rustc --version` and paste the result.

```console
[user@system:~]$ rustc --version
output here
```

If using Nix please run `nix-shell -p nix-info --run "nix-info -m"` and paste the result.
```console
[user@system:~]$ nix-shell -p nix-info --run "nix-info -m"
output here
```

---

#### Notify maintainers

<!--
Please @ people who are relevant to this issue
-->
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: "Feature request"
about: Suggest an idea for this project
labels: 'enhancement'
---

<!--
Thank you for suggesting an idea to make nufmt better.
Please fill in as much of the template below as you're able.
-->

**Is your feature request related to a problem? Please describe.**
Please describe the problem you are trying to solve.

**Describe the solution you'd like**
Please describe the desired behavior.

**Describe alternatives you've considered**
Please describe alternative solutions or features you have considered.
7 changes: 7 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Description of changes

<!-- What changes did you make -->

## Relevant Issues

<!-- Eg. #43 -->

0 comments on commit baccee1

Please sign in to comment.