GitHub Templates

Issue Templates

For issues we have two types of templates depending on the change. If none of these apply, can create an issue from scratch.

To use templates you must go into the repository settings and enable it.

.github/ISSUE_TEMPLATE/defect.md

---
name: Defect
about: Create a report to help us improve
title: "[Defect]"
labels: defect
assignees: bmcano

---

### Describe the defect
<!-- A clear and concise description of the issue. -->

### Steps to Reproduce
<!-- Where to find the defect -->

### Expected behavior
<!-- A clear and concise description of what you expected to happen. -->

### Screenshots
<!-- If applicable, add screenshots to help explain the problem. -->

### Device Information
<!-- If app version, OS, or device specific issue. -->
- App Version:
- Device:
- OS:

### Additional Context
<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/development-story.md

---
name: Development Story
about: Suggest an idea, feature, or change for the app
title: ''
labels: enhancement
assignees: bmcano

---

### Related Issues
<!-- Link any related issues or prerequisite stories as needed.  -->

### Describe the Feature or Change
<!-- A clear and concise description of what you want to happen. -->

### Why Is This Feature Useful?
<!-- Explain why this feature would be beneficial. -->

### Expected Outcome
<!-- What do you expect to happen? -->

### Additional Information
<!-- Include any relevant screenshots, designs, or references. -->

Pull Request Template

Since issues with track any stories we complete we can link them all here and any other small changes we make.

.github/pull_request_template.md

## Description
<!-- Provide a clear and concise summary of the changes in this PR. Include summary of the changes made. -->

## Related Issues
<!-- 
List all related issues and stories here. 
If an issue is fully resolved by this PR, use the "Closes" keyword. 

- Closes [#ISSUE_NUMBER](link-to-issue): Brief description of the issue.
- Relates to [#ISSUE_NUMBER](link-to-issue): Brief description of the related issue.
-->

## Changes
<!-- Describe each major change in a bullet-point list. -->

## Additional Notes
<!-- Include any additional context or screenshots that may help the reviewer understand the changes. -->
<!-- Also, mention any known issues or future improvements planned. -->