Skip to content

Commit

Permalink
Added issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Mnjongen committed Feb 4, 2024
2 parents 2cfb874 + 9656104 commit e50f8cb
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 0 deletions.
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
name: Bug report
about: Report a bug in the Unscrambler project
title: "[BUG]: "
labels: bug
assignees: Mnjongen

---

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

**Input and output**
What letters did you use as input for the Unscrambler method? What words did you get as output?

**Expected and actual behavior**
What did you expect the Unscrambler method to return? What did it actually return?

**Word list file**
What word list file did you use? Please attach it to the issue or provide a link to it.

**Exception or error message**
Did you encounter any exception or error message? If yes, please copy and paste it here.

**Code snippet**
Please provide a minimal and reproducible code snippet that demonstrates the bug. For example:

```csharp
using Unscrambler;

IUnscrambler unscrambler = new BasicUnscrambler();
IWordLoader loader = new BasicWordLoader("words.txt");

// Load words from a file
bool success = await loader.LoadFromFileAsync(unscrambler);

if (success)
{
// Find words from a list of letters
HashSet<string> words = unscrambler.Unscramble("letters");

// Print the words to the console
foreach (string word in words)
{
Console.WriteLine(word);
}
}
else
{
Console.WriteLine("Failed to load words from file.");
}
```

**Environment (please complete the following information):**
- OS: [e.g. Windows, Linux, MacOS]
- .NET version: [e.g. 8.0.1]
- Unscrambler version: [e.g. 1.0.0]

**Additional context**
Add any other context about the problem here.
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: "[FEATURE]: "
labels: enhancement
assignees: Mnjongen

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.

0 comments on commit e50f8cb

Please sign in to comment.