Commit 17ffcdd6 authored by David Haynes's avatar David Haynes 🙆
Browse files

docs: add in issue templates based off of other srct projects

- default.md is the default issue template that every issue should be using.
- bug.md is an issue template designed specifically for bug reports, it asks
for more details which will assist developers

Closes #31
parent f7908cfe
## Expected Behavior
Describe briefly what the app should be doing or, what the expected behavior would
be given a certain input or action.
## Actual Behavior
Describe briefly what actually occurs in the app given the input described above.
## Steps to Reproduce the Behavior
A numbered list of steps starting from the earliest possible moment up until the
bug occurs. Something that could be used by other developers to reproduce the bug
that is being reported.
## Helpful links
Here you should include a bullet point list of links to documentation, stack overflow,
whatever, that could help guide someone on what it is they are trying to do.
Essentially, a list of links to point them in the right direction.
\ No newline at end of file
## Summary
Here you should include two to three sentences explaining the thought process
about the current issue. Perhaps a picture? Some details that could best help someone,
especially someone new, understand the goal of the issue and how they should best
approach the problem.
## Helpful Links
Here you should include a bullet point list of links to documentation, stack overflow,
whatever, that could help guide someone on what it is they are trying to do.
Essentially, a list of links to point them in the right direction.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment