Skip to content

Commit

Permalink
📝 Add issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
takuma-ru committed Jun 7, 2024
1 parent 70ddb04 commit 084f38e
Show file tree
Hide file tree
Showing 10 changed files with 259 additions and 3 deletions.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/add-update-fix-document-page.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Add/Update/Fix Document page
title: \U0001F4DD xxx
description: Documentation-related issues, etc.
labels: [":memo: documentation"]

body:
- type: dropdown
id: type
attributes:
label: Issue type
description: What is the problem?
multiple: false
options:
- "Add"
- "Update"
- "Fix"
default: 0
validations:
required: true

- type: textarea
attributes:
label: Description
description: Please describe your request in detail.
placeholder: |
Please describe your request in detail.
validations:
required: true

- type: textarea
attributes:
label: Additional context
description: Add any other context about the problem here.
placeholder: |
Add any other context about the problem here.
validations:
required: false
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Bug report
description: Create a report to help us improve
title: ":bug: xxx"
labels: [":bug: bug"]
assignees: takuma-ru

body:
- type: textarea
attributes:
label: Describe the bug
description: What happened when you did what?
validations:
required: true

- type: textarea
attributes:
label: To Reproduce
description: Please describe in as much detail as possible the steps you took to generate that bug.
validations:
required: false

- type: textarea
attributes:
label: Terminal Info
description: please complete the following information
value: |
- OS: <!-- macOS -->
- Browser: <!-- Chrome, Safari -->
- Version: <!-- 119 -->
- Library version: <!-- 0.1.0 -->
validations:
required: true

- type: textarea
attributes:
label: Additional context
description: Add any other context about the problem here.
placeholder: |
Add any other context about the problem here.
validations:
required: false
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Feature request
description: Adding new features and improving the functionality of existing features
title: "\U0001F6E0️ xxx"
labels: [":hammer_and_wrench:enhancement"]

body:
- type: textarea
attributes:
label: Describe the improve feature
description: What is the feature you want to improve?
validations:
required: true

- type: textarea
attributes:
label: Additional context
description: Add any other context about the feature here.
placeholder: |
Add any other context about the feature here.
validations:
required: false
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/new-feature-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: NEW Feature request
description: Want to add a completely new feature
title: ":sparkles: xxx"
labels: [":sparkles: feature"]

body:
- type: textarea
attributes:
label: Describe the NEW feature
description: What is the feature you want to add?
validations:
required: true

- type: textarea
attributes:
label: Additional context
description: Add any other context about the feature here.
placeholder: |
Add any other context about the feature here.
validations:
required: false
13 changes: 13 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## What's changed
<!-- Briefly describe what you have done with this PR. -->


## Issue
- #xx

## TODO
<!-- Please describe any issues that have not yet been resolved or that need to be addressed in the future. -->
- [ ] none

## Remark
<!-- Please describe any items that should be shared with reviewers -->
58 changes: 58 additions & 0 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name-template: "Release $RESOLVED_VERSION"
tag-template: "$RESOLVED_VERSION"

categories:
- title: "✨ Features"
labels:
- ":sparkles: feature"
- title: "🛠️ Enhancement"
labels:
- ":hammer_and_wrench: enhancement"
- title: "🐛 Bug Fixes"
labels:
- ":bug: bug"
- title: "🧰 Maintenance"
label: "chore"
- title: "📝 Update Documentation"
labels:
- ":memo: documentation"
- title: "♻️ Refactoring"
labels:
- ":recycle: refactor"

change-template: "- $TITLE @$AUTHOR ([#$NUMBER]($URL))"

change-title-escapes: '\<*_&'

template: |
## Changes
$CHANGES
autolabeler:
- label: ":sparkles: feature"
branch:
- "/^feat(ure)?[/-].+/"
- label: ":bug: bug"
branch:
- "/^fix[/-].+/"
- label: ":recycle: refactor"
branch:
- "/(refactor|refactoring)[/-].+/"
- label: ":memo: documentation"
branch:
- "/doc(umentation)[/-].+/"
files:
- "*.md"
- label: ":hammer_and_wrench: enhancement"
branch:
- "/(enhancement|improve)[/-].+/"
- label: ":rocket: release"
branch:
- "/^release[/-].+/"
- label: ":package: core feature"
files:
- "packages/core/**/**"
- label: ":package: unplugin feature"
files:
- "packages/unplugin/**/**"
41 changes: 41 additions & 0 deletions .github/workflows/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Release Drafter

on:
push:
# branches to consider in the event; optional, defaults to all
# branches:
# - master
# pull_request event is required only for autolabeler
pull_request:
# Only following types are handled by the action, but one can default to all as well
types: [opened, reopened, synchronize]
# pull_request_target event is required for autolabeler to support PRs from forks
# pull_request_target:
# types: [opened, reopened, synchronize]

permissions:
contents: read

jobs:
update_release_draft:
permissions:
# write permission is required to create a github release
contents: write
# write permission is required for autolabeler
# otherwise, read permission is required at least
pull-requests: write
runs-on: ubuntu-latest
steps:
# (Optional) GitHub Enterprise requires GHE_HOST variable set
#- name: Set GHE_HOST
# run: |
# echo "GHE_HOST=${GITHUB_SERVER_URL##https:\/\/}" >> $GITHUB_ENV

# Drafts your next Release notes as Pull Requests are merged into "master"
- uses: release-drafter/release-drafter@v5
# (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
# with:
# config-name: my-config.yml
# disable-autolabeler: true
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
25 changes: 24 additions & 1 deletion packages/core/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,30 @@
{
"name": "@unplugin-lit-sass/core",
"name": "unplugin-lit-sass-core",
"private": false,
"version": "1.0.0",
"author": "takuma-ru <[email protected]> (https://github.com/takuma-ru/)",
"keywords": [
"css",
"sass",
"scss",
"lit",
"lit-element",
"lit-html",
"unplugin"
],
"homepage": "https://github.com/takuma-ru/unplugin-lit-sass/tree/main/packages/core",
"repository": {
"type": "git",
"url": "https://github.com/takuma-ru/unplugin-lit-sass/tree/main/packages/core"
},
"bugs": {
"url": "https://github.com/takuma-ru/unplugin-lit-sass/issues",
"email": "[email protected]"
},
"publishConfig": {
"access": "public",
"registry": "https://registry.npmjs.org/"
},
"type": "module",
"main": "dist/main.js",
"exports": {
Expand Down
1 change: 1 addition & 0 deletions packages/release/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"name": "release",
"private": true,
"version": "1.0.0",
"scripts": {
"build": "tsup",
Expand Down
4 changes: 2 additions & 2 deletions packages/unplugin/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,10 @@
"typescript": "^5.2.2"
},
"dependencies": {
"@unplugin-lit-sass/core": "workspace:*",
"unplugin-lit-sass-core": "workspace:*",
"unplugin": "^1.10.1"
},
"peerDependencies": {
"lit": "^3.0.0"
}
}
}

0 comments on commit 084f38e

Please sign in to comment.