Skip to content

Commit f0f562c

Browse files
AnthonMSAnthonMS
authored
Merge pull request #31 from DenyThis/main
Refactor project structure by using Github's Actions, Issue Templates, and versioning
2 parents 2de642d + d6cd7ab commit f0f562c

38 files changed

+242
-1720
lines changed

‎.gitattributes

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text=auto eol=lf

‎.github/ISSUE_TEMPLATE/bug_report.yml

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: 🐞 Bug Report
2+
description: Create a report to help us improve
3+
title: "[Bug]: <title>"
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Current Behavior
9+
description: A concise description of what you're experiencing.
10+
validations:
11+
required: false
12+
- type: textarea
13+
attributes:
14+
label: Expected Behavior
15+
description: A concise description of what you expected to happen.
16+
validations:
17+
required: false
18+
- type: textarea
19+
attributes:
20+
label: Steps To Reproduce
21+
description: Steps to reproduce the behavior.
22+
placeholder: |
23+
1. In this environment...
24+
2. With this config...
25+
3. Run '...'
26+
4. See error...
27+
validations:
28+
required: false
29+
- type: textarea
30+
attributes:
31+
label: Environment
32+
description: |
33+
examples:
34+
- **OS**: Ubuntu 20.04
35+
- **Brower**: chrome
36+
- **Version**: 1.6.2
37+
- **Hassio**: 2022.2.3
38+
value: |
39+
- OS:
40+
- Node:
41+
- Version:
42+
- Hassio:
43+
render: markdown
44+
validations:
45+
required: false
46+
- type: textarea
47+
attributes:
48+
label: Anything else?
49+
description: |
50+
Links? References? Anything that will give us more context about the issue you are encountering!
51+
52+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.

‎.github/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/feature_request.yml

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: 🚀 Feature request
2+
description: Suggest an idea for this project
3+
title: "[Feature]: <title>"
4+
labels: ["enhancement"]
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Is your feature request related to a problem?
9+
description: >
10+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
validations:
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Describe the solution you'd like
16+
description: >
17+
A clear and concise description of what you want to happen.
18+
validations:
19+
required: true
20+
- type: textarea
21+
attributes:
22+
label: Describe alternatives you've considered
23+
description: >
24+
A clear and concise description of any alternative solutions or features you've considered.
25+
- type: textarea
26+
attributes:
27+
label: Additional context
28+
description: >
29+
Add any other context or screenshots about the feature request.
30+
- type: markdown
31+
attributes:
32+
value: >
33+
Thanks for contributing 🎉

‎.github/PULL_REQUEST_TEMPLATE.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## Description
2+
<!--- Describe your changes in detail -->
3+
4+
## Related Issue
5+
<!--- This project only accepts pull requests related to open issues -->
6+
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
7+
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
8+
<!--- Please link to the issue here -->
9+
10+
## Motivation and Context
11+
<!--- Why is this change required? What problem does it solve? -->
12+
13+
## How Has This Been Tested
14+
<!--- Please describe in detail how you tested your changes. -->
15+
<!--- Include details of your testing environment, and the tests you ran to -->
16+
<!--- see how your change affects other areas of the code, etc. -->
17+
18+
## Types of changes
19+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
20+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
21+
- [ ] 🚀 New feature (non-breaking change which adds functionality)
22+
- [ ] 🌎 Translation (addition or update a translation)
23+
- [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to change)
24+
25+
## Checklist
26+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
27+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
28+
- [ ] My code follows the code style of this project.
29+
- [ ] My change requires a change to the documentation.
30+
- [ ] I have updated the documentation accordingly.
31+
- [ ] I have tested the change locally.

‎.github/release.yml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
changelog:
2+
exclude:
3+
labels:
4+
- ignore-for-release
5+
authors:
6+
- octocat
7+
categories:
8+
- title: Breaking Changes 🛠
9+
labels:
10+
- breaking-change
11+
- title: New Features 🎉
12+
labels:
13+
- enhancement
14+
- title: Fixes 🐛
15+
labels:
16+
- bug
17+
- title: Translations 🌍
18+
labels:
19+
- translations
20+
- title: Other Changes
21+
labels:
22+
- "*"

‎.github/workflows/build.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Build
2+
on:
3+
pull_request:
4+
push:
5+
jobs:
6+
build:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- name: Checkout
10+
uses: actions/checkout@v2
11+
- name: Install
12+
run: npm ci
13+
- name: Build
14+
run: npm run build

‎.github/workflows/release.yaml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Release
2+
on:
3+
push:
4+
tags:
5+
- "v*.*.*"
6+
jobs:
7+
release:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout
11+
uses: actions/checkout@v2
12+
- name: Install
13+
run: npm ci
14+
- name: Build
15+
run: npm run build
16+
- name: Release
17+
uses: softprops/action-gh-release@v1
18+
if: startsWith(github.ref, 'refs/tags/')
19+
with:
20+
draft: true
21+
generate_release_notes: true
22+
files: dist/*.js

‎.github/workflows/validate.yaml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: HACS validation
2+
on:
3+
push:
4+
branches:
5+
- main
6+
jobs:
7+
validate:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout
11+
uses: actions/checkout@v2
12+
- name: HACS validation
13+
uses: "hacs/action@main"
14+
with:
15+
category: "plugin"

‎README.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,11 @@ Hopefully some of you find these updates as exciting as I do. I'm looking forwar
1414

1515

1616
## Table of contents
17-
- [Installation](/other/docs/installation.md)
18-
- [my-slider](/other/docs/slider.md)
19-
- [my-slider-v2](/other/docs/slider-v2.md)
20-
- [my-button](/other/docs/button.md)
21-
- [Development](/other/docs/dev.md)
17+
- [Installation](/docs/installation.md)
18+
- [my-slider](/docs/cards/slider.md)
19+
- ![Example](/docs/images/my-slider/ha-slider-card-demo.gif)
20+
- [my-slider-v2](/docs/cards/slider-v2.md)
21+
- ![Examples](/docs/images/my-slider-v2/examples.png)
22+
- [my-button](/docs/cards/button.md)
23+
- ![Examples](/docs/images/my-button/example-1.png)
24+
- [Development](/docs/dev.md)

0 commit comments

Comments
 (0)