Skip to content

Commit

Permalink
chore: Issue and PR Template (#277)
Browse files Browse the repository at this point in the history
  • Loading branch information
ABausG authored Jul 16, 2024
1 parent 3066e72 commit f83924c
Show file tree
Hide file tree
Showing 5 changed files with 198 additions and 0 deletions.
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: Bug Report
about: You discovered a Bug in your Homescreen Widget / in the home_widget Plugin
labels: ["bug"]

body:
- type: markdown
attributes:
value: |
When reporting a bug, please read this complete template and fill in all the questions in order to get a better response! Before filing a bug please make sure you read the documentation, check for related issues and discussions.
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Tell us, what happened?
validations:
required: true

- type: textarea
id: expectation
attributes:
label: What do you expect?
description: Also tell us, what behavior did you expect?
validations:
required: true

- type: textarea
id: logs
attributes:
label: Relevant log output
description: If you have any debug / error logging, please fill it here within the code block below
render: shell

- type: textarea
attributes:
label: Execute in a terminal and put output into the code block below
value: 'Output of: flutter doctor -v'

- type: dropdown
id: affected-platforms
attributes:
label: On which Platform do you experience this issue?
multiple: true
options:
- Android
- iOS
validations:
required: true

- type: textarea
id: other-information
attributes:
label: Other information
description: Do you have any other useful information about this bug report? Please write it down here

- type: checkboxes
id: terms
attributes:
label: Are you interested in working on a PR for this?
options:
- label: I want to work on this
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: I need a help with building my Widget.
url: https://github.com/ABausG/home_widget/discussions
about: Have a look at the discussions, maybe your question is already answered. Or the community can help you!
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Feature request
description: Suggest a new feature for home_widget.
labels: [ "enhancement" ]
body:
- type: markdown
attributes:
value: |
When suggesting a feature, please read this complete form and fill in all the questions in order to get a better response!
- type: textarea
id: problem-to-solve
attributes:
label: Problem to solve
description: Which problem would be solved with this feature?
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposal
description: What do you propose as a solution? Add as much information as you can!
validations:
required: true
- type: textarea
id: more-information
attributes:
label: More information
description: Do you have any other useful information about this feature report? Please write it down here. Possible helpful information are references to other sites/repositories.
- type: dropdown
id: affected-platforms
attributes:
label: Which Platform would be improved?
multiple: true
options:
- Android
- iOS
- type: checkboxes
id: other
attributes:
label: Other
options:
- label: Are you interested in working on a PR for this?
58 changes: 58 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
<!--
The title of your PR on the line above should start with a [Conventional Commit] prefix
(`fix:`, `feat:`, `docs:`, `test:`, `chore:`, `refactor:`, `perf:`, `build:`, `ci:`,
`style:`, `revert:`). This title will later become an entry in the [CHANGELOG], so please
make sure that it summarizes the PR adequately.
-->

# Description
<!--
Provide a description of what this PR is doing.
If you're modifying existing behavior, describe the existing behavior, how this PR is changing it,
and what motivated the change. If this is a breaking change, specify explicitly which APIs were
changed.
-->
Replace this text.

## Checklist
<!--
Before you create this PR confirm that it meets all requirements listed below by checking the
relevant checkboxes with `[x]`. If some checkbox is not applicable, mark it as `[-]`.
-->

- [ ] I have updated/added tests for ALL new/updated/fixed functionality.
- [ ] I have updated/added relevant documentation and added code (documentation) comments where necessary.
- [ ] I have updated/added relevant examples in `example` or documentation.


## Breaking Change?
<!--
Would your PR require home_widget users to update their apps following your change?
If yes, then the title of the PR should include "!" (for example, `feat!:`, `fix!:`). See
[Conventional Commit] for details. Also, for a breaking PR uncomment and fill in the "Migration
instructions" section below.
-->

- [ ] Yes, this PR is a breaking change.
- [ ] No, this PR is not a breaking change.

<!--
### Migration instructions
If the PR is breaking, uncomment this header and add instructions for how to migrate from the
currently released version below:
-->


## Related Issues
<!--
Indicate which issues this PR resolves, if any. For example:
Closes #1234
!-->

<!-- Links -->
[Conventional Commit]: https://conventionalcommits.org
[CHANGELOG]: https://github.com/abausg/home_widget/blob/main/CHANGELOG.md
<!-- End of exclude from commit message -->
34 changes: 34 additions & 0 deletions .github/workflows/title-validator.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# See https://github.com/amannn/action-semantic-pull-request
name: 'PR Title is Conventional'

on:
pull_request_target:
types:
- opened
- edited
- synchronize

jobs:
main:
name: Validate PR title
runs-on: ubuntu-latest
steps:
- uses: amannn/action-semantic-pull-request@v5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
types: |
build
chore
ci
docs
feat
fix
perf
refactor
revert
style
test
subjectPattern: ^[A-Z].+$
subjectPatternError: |
The subject of the PR must begin with an uppercase letter.

0 comments on commit f83924c

Please sign in to comment.