Merge pull request #31 from DenyThis/main

Refactor project structure by using Github's Actions, Issue Templates, and versioning

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,52 @@
+name: 🐞 Bug Report
+description: Create a report to help us improve
+title: "[Bug]: <title>"
+labels: ["bug", "triage"]
+body:
+- type: textarea
+  attributes:
+    label: Current Behavior
+    description: A concise description of what you're experiencing.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Expected Behavior
+    description: A concise description of what you expected to happen.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Steps To Reproduce
+    description: Steps to reproduce the behavior.
+    placeholder: |
+      1. In this environment...
+      2. With this config...
+      3. Run '...'
+      4. See error...
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Environment
+    description: |
+      examples:
+        - **OS**: Ubuntu 20.04
+        - **Brower**: chrome
+        - **Version**: 1.6.2
+        - **Hassio**: 2022.2.3
+    value: |
+        - OS:
+        - Node:
+        - Version:
+        - Hassio:
+    render: markdown
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Anything else?
+    description: |
+      Links? References? Anything that will give us more context about the issue you are encountering!
+
+      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

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,33 @@
+name: 🚀 Feature request
+description: Suggest an idea for this project
+title: "[Feature]: <title>"
+labels: ["enhancement"]
+body:
+- type: textarea
+  attributes:
+    label: Is your feature request related to a problem?
+    description: >
+      A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Describe the solution you'd like
+    description: >
+      A clear and concise description of what you want to happen.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Describe alternatives you've considered
+    description: >
+      A clear and concise description of any alternative solutions or features you've considered.
+- type: textarea
+  attributes:
+    label: Additional context
+    description: >
+      Add any other context or screenshots about the feature request.
+- type: markdown
+  attributes:
+    value: >
+      Thanks for contributing 🎉

.github/PULL_REQUEST_TEMPLATE.md

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

.github/release.yml

@@ -0,0 +1,22 @@
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+    authors:
+      - octocat
+  categories:
+    - title: Breaking Changes 🛠
+      labels:
+        - breaking-change
+    - title: New Features 🎉
+      labels:
+        - enhancement
+    - title: Fixes 🐛
+      labels:
+        - bug
+    - title: Translations 🌍
+      labels:
+        - translations
+    - title: Other Changes
+      labels:
+        - "*"

.github/workflows/build.yml

@@ -0,0 +1,14 @@
+name: Build
+on:
+    pull_request:
+    push:
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v2
+            - name: Install
+              run: npm ci
+            - name: Build
+              run: npm run build

.github/workflows/release.yaml

@@ -0,0 +1,22 @@
+name: Release
+on:
+    push:
+        tags:
+            - "v*.*.*"
+jobs:
+    release:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v2
+            - name: Install
+              run: npm ci
+            - name: Build
+              run: npm run build
+            - name: Release
+              uses: softprops/action-gh-release@v1
+              if: startsWith(github.ref, 'refs/tags/')
+              with:
+                  draft: true
+                  generate_release_notes: true
+                  files: dist/*.js

.github/workflows/validate.yaml

@@ -0,0 +1,15 @@
+name: HACS validation
+on:
+    push:
+        branches:
+            - main
+jobs:
+    validate:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v2
+            - name: HACS validation
+              uses: "hacs/action@main"
+              with:
+                  category: "plugin"

README.md

@@ -14,8 +14,11 @@ Hopefully some of you find these updates as exciting as I do. I'm looking forwar
 
 
 ## Table of contents
-- [Installation](/other/docs/installation.md)
-- [my-slider](/other/docs/slider.md)
-- [my-slider-v2](/other/docs/slider-v2.md)
-- [my-button](/other/docs/button.md)
-- [Development](/other/docs/dev.md)
+  - [Installation](/docs/installation.md)
+  - [my-slider](/docs/cards/slider.md)
+    - ![Example](/docs/images/my-slider/ha-slider-card-demo.gif)
+  - [my-slider-v2](/docs/cards/slider-v2.md)
+    - ![Examples](/docs/images/my-slider-v2/examples.png)
+  - [my-button](/docs/cards/button.md)
+    - ![Examples](/docs/images/my-button/example-1.png)
+  - [Development](/docs/dev.md)