Skip to content

Commit

Permalink
feat(templates): new github templates (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
Drag0ndust authored Jul 9, 2024
1 parent 67c043a commit c2a380d
Show file tree
Hide file tree
Showing 3 changed files with 90 additions and 64 deletions.
69 changes: 37 additions & 32 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,37 @@
---
name: Bug Report
about: Create a report to help us improve
title: BUG -
labels: bug
assignees: ''

---

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

## To Reproduce
Steps to reproduce the behavior:
1. Go to '...'
2. Tap on this button '....'
3. Scroll down to '....'
4. See error

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

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

## Device Info (please complete the following information):
* Device: [e.g. iPhone14]
* OS: [e.g. iOS 16.0]
* App Version [e.g. v1.5]

## Additional Context
* Add any other context about the problem here.
name: "\U0001F41E Bug report"
title: BUG -
description: Create a report to help us improve OpenSourceTemplate
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Please carefully read the contribution docs before creating a bug report
- type: textarea
id: reproduction
attributes:
label: Reproduction
description: Please provide a description how we can reproduce the problem you ran into.
placeholder: Reproduction
validations:
required: true
- type: textarea
id: bug-description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks!
placeholder: Bug description
validations:
required: true
- type: textarea
id: additonal
attributes:
label: Additional context
description: If applicable, add any other context about the problem here
- type: textarea
id: logs
attributes:
label: Logs
description: |
Optional if provided reproduction. Please try not to insert an image but copy paste the log text.
render: shell-script
40 changes: 25 additions & 15 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,27 @@
---
name: Feature Request
about: Suggest an idea for this project
name: "🚀 Feature request"
title: FEATURE -
labels: feature request
assignees: ''
description: Suggest a feature that will improve the OpenSourceTemplate
labels: ["feature request"]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to fill out this feature request!

---

## Describe the feature you want the app to have that it currently doesn't
* 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.
Please carefully read the contribution docs before suggesting a new feature
- type: textarea
id: feature-description
attributes:
label: Describe the feature
description: A clear and concise description of what you think would be a helpful addition to OpenSourceTemplate, including the possible use cases and alternatives you have considered. If you have a working prototype or package that implements it, please include a link.
placeholder: Feature description
validations:
required: true
- type: checkboxes
id: additional-info
attributes:
label: Additional information
description: Additional information that helps us decide how to proceed.
options:
- label: Would you be willing to help implement this feature?
- label: Could this feature be implemented as a module?
45 changes: 28 additions & 17 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,28 @@
# What it Does
* Closes #
* Describe what your change does

# How I Tested
* Add a list of steps to show the functionality of your feature
For example:
* Run the application
* Tap the (+) button
* See this screen
etc...

# Notes
* Anything else that should be noted about how you implemented this feature?

# Screenshot
* Add a screenshot of your new feature! OR show a screen recording of it in action. (On the simulator press Cmd + R to record, and the top button at the top when done). **This video should be longer than 30 seconds.**
name: "Pull Request"
body:
- type: markdown
attributes:
value: |
Thank you for this pull request!
- type: textarea
id: pr-description
attributes:
label: Describe the Pull-Request
description: What is you Pull-Request adding to the project? Also include a issue number which this PR addresses, e.g. Closes #1
placeholder: PR Description
- type: textarea
id: test-description
attributes:
label: Testing Steps
description: Add a list of steps to show the functionality of your feature
placeholder: Steps to test...
- type: textarea
id: note-description
attributes:
label: Notes
description: Anything else that should be noted about how you implemented this feature?
- type: textarea
id: screenshot
attributes:
label: Screenshot
description: Add a screenshot of your new feature! OR show a screen recording of it in action. (On the simulator press Cmd + R to record, and the top button at the top when done). **This video should be longer than 30 seconds.**

0 comments on commit c2a380d

Please sign in to comment.