Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Dioscorides committed Jan 21, 2024
1 parent b3c96fd commit 10a2828
Show file tree
Hide file tree
Showing 2 changed files with 93 additions and 0 deletions.
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
name: Bug report
about: Create a bug report to help us improve
title: "[BUG] "
labels: bug
assignees: ''

---

## Summary
Briefly describe the bug you encountered. Use simple and clear language. For example:

> I encountered a 404 error when I tried to access the contact page.
## Steps to Reproduce
List the steps to reproduce the bug. Be as specific as possible. For example:

> 1. Open the web application in Chrome browser.
> 2. Click on the 'Contact Us' link in the footer.
> 3. Observe the error message on the screen.
## Expected Result
Describe what you expected to happen. For example:

> I expected to see the contact page with a form to send a message.
## Actual Result
Describe what actually happened. For example:

> I saw a 404-error page with the message 'The page you are looking for does not exist.'
## Environment
Provide information about your operating system, browser, device, etc. This can help the developers to identify the source of the bug. For example:

> - Operating system: Windows 10
> - Browser: Chrome 96.0.4664.45
> - Device: Laptop
## Screenshots
Attach any screenshots or videos that demonstrate the bug. This can help the developers to visualize the problem and debug it faster. For example:

> Here is a screenshot of the error page:
![404 error](https://example.com/404-error.png)

## Additional Information
Provide any additional information that might be relevant or helpful. For example:

> - The bug only occurs in Chrome browser. I tried it in Firefox and Edge and it worked fine.
> - The bug started happening after the last update of the web application.
> - The bug does not affect the functionality of the other pages.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: Feature request
about: Suggest an idea for the DMMapp
title: "[FEATURE REQUEST] "
labels: enhancement
assignees: ''

---

## Summary
Briefly describe the feature you want to add. Use simple and clear language. For example:

> I would like to add a dark mode option to the web application.
## Motivation
Explain why this feature is needed, and how it benefits the application the the users. You can mention the problem it solves, the user pain points it addresses, or the value it adds. For example:

> Dark mode is a popular feature that many users prefer, especially at night or in low-light environments. It can also reduce eye strain and save battery life. Adding a dark mode option would improve the user experience and satisfaction.
## Description
Provide a detailed description of the feature. Include user stories, if applicable. User stories are short sentences that describe what a user wants to do and why. They follow the format: "As a [type of user], I want to [do something], so that [I achieve some goal]." For example:

> As a user, I want to toggle dark mode on and off, so that I can choose the best display option for my eyes and environment.
> As a user, I want to see the dark mode option in the settings menu, so that I can easily access it.
## Alternatives
Discuss any alternative solutions or features you've considered. You can compare and contrast them with your proposed feature and explain why your feature is better or more suitable. For example:

> An alternative solution would be to automatically adjust the display brightness based on the ambient light. However, this might not work well for some users who have different preferences or sensitivities. A dark mode option would give users more control and flexibility.
## Additional context
Add any other context or screenshots about the feature request here. You can use images to illustrate your idea or show examples of similar features in other applications. For example:

> Here is a mockup of how the dark mode option would look like in the settings menu:
![Dark mode mockup](https://example.com/dark-mode-mockup.png)

## Acceptance Criteria
List the requirements that must be met for the feature to be considered complete. These are the specific and measurable outcomes that you expect from the feature. For example:

- The feature should be compatible with all major browsers and devices.
- The feature should be accessible and follow the web accessibility guidelines.

0 comments on commit 10a2828

Please sign in to comment.