Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Templates for issues/pull tracker #99

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
23 changes: 23 additions & 0 deletions docs/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!--
(Thanks for sending a pull request! Please make sure you click the link above to view the contribution guidelines, then fill out the blanks below.)
-->

#### Checklist

- [ ] There is a corresponding issue for this pull request.
- [ ] My branch is up-to-date with the Upstream `master` branch.
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have added necessary documentation (if appropriate)

#### Short description of what this resolves:


#### Changes proposed in this pull request:

-
-
-

<!-- Add the issue number that is fixed by this PR (In the form Fixes #123) -->

Fixes #
35 changes: 35 additions & 0 deletions docs/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: "BUG: "
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Forcing BUG: prefix for bug format

Copy link
Contributor

@RobLoach RobLoach Sep 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prefixing the issue type may not be necessary when the correct label is applied.

name: Bug report
labels: bug-report "P3 - Normal"
assignees: kreyren nntoan
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added labels and default assignees

about: Create a report to help us improve

---

**I'm submitting a ...** (check one with "x")
- [x] bug report
- [ ] feature request

**Actual Behaviour**

<!-- Describe how the bug manifests. -->

**Expected Behaviour**

<!-- State here what the feature should enable the user to do. -->

**Steps to reproduce it**

<!-- Add steps to reproduce bugs or add information on the place where the feature should be implemented. Add links to a sample deployment or code. -->

**System information:**

<!-- Add information about the system your facing this bug on. If you think this is irrelevant or if it's a UI bug or a feature request, please remove this section -->
```
Your operating system
```

**Would you like to work on the issue?**

<!-- Let us know if this issue should be assigned to you or tell us who you think could help to solve this issue. -->
32 changes: 32 additions & 0 deletions docs/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Feature request
about: Suggest an idea for this project

---

**I'm submitting a ...** (check one with "x")
- [ ] bug report
- [x] feature request

**Actual Behaviour**

<!-- Describe how the bug manifests. -->

**Expected Behaviour**

<!-- State here what the feature should enable the user to do. -->

**Steps to reproduce it**

<!-- Add steps to reproduce bugs or add information on the place where the feature should be implemented. Add links to a sample deployment or code. -->

**System information:**

<!-- Add information about the system your facing this bug on. If you think this is irrelevant or if it's a UI bug or a feature request, please remove this section -->
```
Your operating system
```

**Would you like to work on the issue?**

<!-- Let us know if this issue should be assigned to you or tell us who you think could help to solve this issue. -->