Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update GitHub templates #201

Merged
merged 8 commits into from
Oct 23, 2023
Merged
42 changes: 19 additions & 23 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,37 @@
---
name: Bug report
about: Create a report to help us improve
name: Bug Report
about: Report a bug to help us improve our app
title: 'Bug: '
labels: 'bug'
assignees: ''
labels: 'type: bug'

---

**Describe the bug**
## Describe the Bug

A clear and concise description of what the bug is.

**To Reproduce**
## To Reproduce

Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
1. Step 1
2. Step 2
3. ...

## Expected Behavior

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.
## Screenshots

**Desktop (please complete the following information):**
If applicable, add screenshots to help explain your problem.

- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
## Device Information

**Smartphone (please complete the following information):**
- Device: [e.g., iPhone 14, Google Pixel 7]
- OS: [e.g., iOS 16, Android 13]
- App Version: [e.g., v1.4.4]

- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
## Additional Context

**Additional context**
Add any other context about the problem here.
23 changes: 11 additions & 12 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
---
name: Feature request
about: Suggest an idea for TAT
name: Feature Request
about: Suggest an idea or enhancement for our app
title: 'Feature: '
labels: 'Feature'
assignees: ''
labels: 'type: feature request'

---

## Description
## Feature Description

-
A clear and concise description of the feature you would like to request.

## How to implement?
## Use Case

-
Explain how this feature would benefit the users or the project.

## Design(optional)
## Proposed Implementation

-
If you have any ideas on how this feature could be implemented, describe them here.
ntut-xuan marked this conversation as resolved.
Show resolved Hide resolved

## Additional contexts(optional)
## Additional Context

-
Add any other context or screenshots about the feature request here.
28 changes: 23 additions & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,27 @@
## Description <!-- btsbot.attachSection(<<##) -->
## Description

-
Please describe your changes in detail.

## How to Verify? <!-- btsbot.attachSection(<<##) -->
### Related Issue

-
- Link to the related issue (if applicable):
- Fixes # (issue number)

## Screenshots/GIF/Test Results (Optional) <!-- btsbot.attachSection(<<##) -->
## Screenshots

If your changes include visual elements,
consider attaching relevant screenshots or GIFs.

## Checklist

Before submitting this PR, please make sure you have done the following:

- [ ] Checked your code for syntax errors and formatting issues.
- [ ] Reviewed your changes to ensure they match the project's coding style and conventions.
- [ ] Included any necessary documentation updates.
- [ ] Added or updated relevant tests (if applicable).
- [ ] Verified that the app still builds and runs without errors.

## Additional Notes

Add any additional information or context about the changes made in this PR.