Skip to content

Commit

Permalink
Update issue templates (dotimplement#64)
Browse files Browse the repository at this point in the history
Addresses issue dotimplement#62
  • Loading branch information
adamkells authored Sep 30, 2024
1 parent ef94b0d commit a4beb13
Show file tree
Hide file tree
Showing 3 changed files with 76 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

## Description
<!-- Short description of the problem here. -->

## Context
<!-- How has this bug affected you? What were you trying to accomplish? -->

## Steps to Reproduce
<!-- 1. [First Step]
2. [Second Step]
3. [And so on...] -->

## Expected Result
<!-- Tell us what should happen. -->

## Actual Result
<!-- Tell us what happens instead. -->

```
-- If you received an error, place it here.
```

```
-- Separate them if you have more than one.
```

## Your Environment
<!-- Include as many relevant details about the environment in which you experienced the bug: -->

* Healthchain version used (`pip show healthchain`):
* Python version used (`python -V`):
* Operating system and version:
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-improvement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: Documentation Improvement
about: Suggest an improvement to the documentation
title: ''
labels: ''
assignees: ''

---

## Description
<!-- Short description of the improvement suggestion. -->

### Documentation page (if applicable)

## Context
<!-- Extra context. -->
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
title: ''
labels: ''
assignees: ''

---

## Description
<!-- Is your feature request related to a use case which is difficult to implement? "I am trying to do XYZ and am finding it difficult to ..." -->

## Context
<!-- Why is this change important to you? How would you use it? How can it benefit other users? -->

## Possible Implementation
<!-- (Optional) Suggest an idea for implementing the addition or change. -->

## Possible Alternatives
<!-- (Optional) Describe any alternative solutions or features you've considered. -->

0 comments on commit a4beb13

Please sign in to comment.