Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 81 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
name: 🐛 Bug report
description: Create a report to help us improve.
body:
- type: markdown
attributes:
value: |
We appreciate you reporting a bug!

Please provide as much detail as you can in the form below.
- type: textarea
id: description
validations:
required: true
attributes:
label: Description
description: |
Please describe the bug in as much detail as possible. Include what occurred. If you have an error message, please include as much of the error message as possible.
- type: textarea
id: steps_to_reproduce
validations:
required: true
attributes:
label: What steps will reproduce the bug?
description: >
Enter details on how to reproduce your bug, preferably a simple code snippet. If textual output included and if possible, please provide numbered steps or bullet points.
- type: textarea
id: frequency
validations:
required: true
attributes:
label: How frequently does this occur? Are there any specific conditions needed?
- type: textarea
id: expected_behavior
validations:
required: true
attributes:
label: What is the expected behavior? Why do you consider this the expected outcome?
description: If possible please provide textual output instead of screenshots.
- type: textarea
id: actual_behavior
validations:
required: true
attributes:
label: What do you see instead?
description: If possible please provide textual output instead of screenshots.
- type: input
id: browser
validations:
required: true
attributes:
label: Browser
description: |
What browser are you using?
Run the following in the browser console and provide the output:
```javascript
console.log(navigator.userAgent);
```
- type: input
id: node_version
validations:
required: true
attributes:
label: Node Version
description: |
Output of `node -v`.
Please verify that you are reproducing the issue in a [currently-supported version](https://github.com/nodejs/Release/blob/HEAD/README.md#release-schedule) of Node.js.
- type: textarea
id: platform
validations:
required: true
attributes:
label: Platform
render: text
description: |
UNIX: output of `uname -srm`
Windows: output of `"$([Environment]::OSVersion.VersionString) $(('x86', 'x64')[[Environment]::Is64BitOperatingSystem])"` in PowerShell console
- type: textarea
id: additional_info
attributes:
label: Additional information
description: Tell us anything else you think we should know.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: 🚀 Feature request
description: Request a new feature.
labels: [feature request]
body:
- type: markdown
attributes:
value: |
Thank you for suggesting an idea!

Please provide as much information as you can in the form below.
- type: checkboxes
attributes:
options:
- label: This is not a substantial change
required: true
- type: textarea
id: description
validations:
required: true
attributes:
label: Description
description: |
Please describe the feature request in as much detail as possible, including examples of how you would use the new feature.
- type: textarea
id: problem_to_solve
validations:
required: true
attributes:
label: What is the problem this feature will solve?
- type: textarea
id: alternatives
validations:
required: true
attributes:
label: What alternatives have you considered?
description: |
Please describe any alternatives or workarounds you have considered that could be used instead of this feature.
13 changes: 3 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,13 @@ We welcome and appreciate all contributions from the community. By contributing

Before creating a bug report please check to see if it has already been reported. If the issue is closed, please open a new issue and link it to the original issue.

When creating a bug report, explain the problem and include as much additional information as necessary to help maintainers to reproduce it. Ideally, provide an example project which highlights the problem.

- **Use a clear and descriptive title** for the issue to identify the problem
- **Describe your project setup**. The easier it is for maintainers to reproduce your problem, the more likely it is to be quickly fixed.
- **Explain what you expected to see instead and why**
When creating a bug report, please fill out the template provided.

### Feature Request

Before creating a feature request, please check to see if it has already been requested.

When creating an enhancement request, explain your use case and ultimate goal. This will make it possible for contributors to suggest existing alternatives which may already meet your requirements.

- **Use a clear and descriptive title** for the issue to identify the suggestion.
- **Provide an example where this enhancement would improve Study Timer**
When creating a feature request, please fill out the template provided.

### Documentation

Expand Down Expand Up @@ -271,7 +264,7 @@ Before you submit your Pull Request (PR) consider the following:
git push -u origin my-fix-branch-issue-id
```

9. In GitHub, send a pull request to `Study Timer:main`.
9. In GitHub, send a pull request to `studytimer.io:main`.

### Reviewing a Pull Request

Expand Down
Loading