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

Add issue/pr templates #20

Merged
merged 1 commit into from
Nov 19, 2024
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
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: Bug Report
description: Report an issue with the code.
labels: ["bug" , "Needs Review"]
body:

- type: textarea
id: describe-the-bug
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is and how to repoduce it.
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
placeholder: |
Example:
"This happened..."
validations:
required: true

- type: textarea
id: actual-behavior
attributes:
label: Actual behavior
description: Explain what actually happens.
placeholder: |
Example:
"This happened instead..."
validations:
required: true

- type: textarea
id: os-details
attributes:
label: Operating System Information
validations:
required: true

- type: textarea
id: log-info
attributes:
label: Log Output
description: Include any log output within the code blocks.
value: |
```

```

- type: checkboxes
id: acknowledgements
attributes:
label: Troubleshooting steps
description: Before reporting an issue follow these troubleshooting steps to see if it solves the issue.
options:
- label: This issue is related to the self-hosting code and not an API issue.
required: true
- label: I have read through the [README](https://github.com/Pirate-Weather/pirate-weather-code/blob/main/README.md) before opening this issue.
required: true
- label: I have written an informative title.
required: true
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: false
contact_links:
- name: Questions
url: https://github.com/Pirate-Weather/pirate-weather-code/discussions
about: Please ask and answer questions here.
- name: API Repository
url: https://github.com/Pirate-Weather/pirateweather/
about: Report issues with and request features to the API here.
- name: Home Assistant Repository
url: https://github.com/Pirate-Weather/pirate-weather-ha
about: Please report any issues with the Home Assistant integration here.
- name: Translations Repository
url: https://github.com/Pirate-Weather/translations
about: Please report any issues with the translations used in the API here.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/general.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: General Issue
description: Report an issue which doesn't fit in with any of the other categories.
labels: ["Needs Review"]
body:

- type: textarea
id: describe-the-issue
attributes:
label: Describe the issue
validations:
required: true

- type: checkboxes
id: acknowledgements
attributes:
label: Acknowledgements
options:
- label: This issue is related to the self-hosting code and not an API issue.
required: true
- label: I have read through the [README](https://github.com/Pirate-Weather/pirate-weather-code/blob/main/README.md) before opening this issue.
required: true
- label: I have written an informative title.
required: true
15 changes: 15 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## Describe the change

## Type of change

- [ ] Bugfixes to existing code
- [ ] Breaking change
- [ ] Code quality improvements to existing code or addition of tests
- [ ] Documentation Updates

## Checklist

- This pull request fixes issue: fixes #
- [ ] Code builds locally. **Your pull request won't be merged unless tests pass**
- [ ] Code has been formatted using ruff
- [ ] I have signed the CLA agreement
Loading