Fix typos and grammar

This commit is contained in:
DigiLive
2025-04-23 06:40:06 +02:00
parent 3b30cd951b
commit da936e9c3d
2 changed files with 80 additions and 10 deletions

35
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@@ -0,0 +1,35 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
---
**Describe the bug**
A clear and concise description of what the bug is.
**Versions**
* Mushroom-Strategy:
* HACS:
* Mushroom:
* Home Assistant:
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '…'
2. Click on '…'
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.
**Additional context**
Add any other context about the problem here.

View File

@@ -1,13 +1,48 @@
Please click the `Preview` tab and select the type of Pull Request you are submitting.
- [Bug Fix](?expand=1&template=bugfix.md)
- [Feature](?expand=1&template=feature.md)
> [!NOTE]
> The above types do not apply to any translation itself.
> To add or fix a translation, select a type below.
> Follow the instructions inside the brackets and remove them.
> In the Title field above, Provide a succinct and descriptive title for the pull request, e.g., "Improve caching
> mechanism for API calls"
>
> - [Translation Contribution](?expand=1&template=translation.md)
> Follow the commit guidelines as described at https://github.com/DigiLive/gitChangelog/wiki/1-Introduction
> [!CAUTION]
> Any Pull Request that does not follow the above types will be rejected.
## Description
[Provide a detailed explanation of the changes you have made. Include the reasons behind these changes and any relevant context. Link any related issues.]
## Type of Change
_Put an `x` in all boxes that apply_
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] Hot fix (corrects a major software bug or fault and should be released as quickly as possible.)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update
- [ ] Refactoring
- [ ] Security patch
- [ ] UI/UX improvement
## Testing
[Detail the testing you have performed to ensure that these changes function as intended. Include information about any added tests.]
## Impact
[Discuss the impact of your changes on the project. This might include effects on performance, new dependencies, or changes in behavior.]
## Additional Information
[Any additional information that reviewers should be aware of.]<br>
[E.g.: Add (before/after) images when visual changes are applied.]
## Checklist
_Put an `x` in all boxes that apply_
- [ ] My code adheres to
the [coding and style guidelines](https://github.com/AalianKhan/mushroom-strategy/blob/main/CONTRIBUTING.md) of the
project.
- [ ] I have performed a self-review of my own code.
- [ ] I have commented my code, particularly in hard-to-understand areas.
- [ ] I have made corresponding changes to the documentation.
- [ ] My changes generate no new warnings.