Release: 1.0.0

.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,25 +4,28 @@ about: Create a report to help us improve
 title: Bug
 labels: bug
 assignees: changchanghwang
-
 ---
 
-|name|about|title|labels|assignees|
-|--|--|--|--|--|
-|💩Bug report|Create a report to help us improve||||
+| name         | about                              | title | labels | assignees |
+| ------------ | ---------------------------------- | ----- | ------ | --------- |
+| 💩Bug report | Create a report to help us improve |       |        |           |
+
+### Describe the bug
 
-### Describe the bug 
 A clear and concise description of what the bug is.
 
-### Expected behavior 
+### Expected behavior
+
 A clear and concise description of what you expected to happen.
 
 ### Example Code
+
 ```ts
-console.log('hello world')
+console.log('hello world');
 ```
 
 ### Information
+
 Version[e.g. v0.1.0]:
 OS[e.g. iOS]:
 Browser[e.g. chrome 62]:

.github/ISSUE_TEMPLATE/feature_request.md

@@ -3,26 +3,29 @@ name: Feature request
 about: Suggest an idea for this project
 title: Feature
 labels: enhancement
-assignees: ActaV-N, sm9657, changchanghwang
-
+assignees: changchanghwang
 ---
 
-|name|about|title|labels|assignees|
-|--|--|--|--|--|
-|✨Feature|this is a awesome feature||||
+| name      | about                     | title | labels | assignees |
+| --------- | ------------------------- | ----- | ------ | --------- |
+| ✨Feature | this is a awesome feature |       |        |           |
+
+### Describe the feature
 
-### Describe the feature 
 A clear and concise description of what the feature do.
 
-### Expected behavior 
+### Expected behavior
+
 A clear and concise description of what you expected to happen.
 
 ### Example Code
+
 ```ts
-console.log('hello world')
+console.log('hello world');
 ```
 
 ### Information
+
 Version[e.g. v0.1.0]:
 OS[e.g. iOS]:
 Browser[e.g. chrome 62]:

.github/auto_assign.yml

@@ -0,0 +1,27 @@
+# Set to true to add reviewers to pull requests
+addReviewers: true
+
+# Set to true to add assignees to pull requests
+addAssignees: true
+
+# A list of reviewers to be added to pull requests (GitHub user name)
+reviewers:
+  - myunggyuns
+  - sunnieeeYoon
+  - changchanghwang
+
+# A number of reviewers added to the pull request
+# Set 0 to add all the reviewers (default: 0)
+numberOfReviewers: 2
+
+# A list of assignees, overrides reviewers if set
+assignees:
+  - changchanghwang
+
+# A number of assignees to add to the pull request
+# Set to 0 to add all of the assignees.
+# Uses numberOfReviewers if unset.
+numberOfAssignees: 1
+# A list of keywords to be skipped the process that add reviewers if pull requests include it
+# skipKeywords:
+#   - wip

.github/workflows/pr-ci.yml

@@ -0,0 +1,35 @@
+name: ci when pull request
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.11.x]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+      - name: Cache node modules
+        uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: ${{ runner.OS }}-build-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.OS }}-build-
+            ${{ runner.OS }}-
+      - name: Package install
+        run: npm ci
+      - name: lint
+        run: |
+          npm run lint

.vscode/extensions.json

@@ -1,8 +1,5 @@
 {
-	// See http://go.microsoft.com/fwlink/?LinkId=827846
-	// for the documentation about the extensions.json format
-	"recommendations": [
-		"dbaeumer.vscode-eslint",
-        "ms-vscode.extension-test-runner"
-	]
+  // See http://go.microsoft.com/fwlink/?LinkId=827846
+  // for the documentation about the extensions.json format
+  "recommendations": ["dbaeumer.vscode-eslint", "ms-vscode.extension-test-runner"]
 }

.vscode/tasks.json

@@ -1,20 +1,16 @@
 // See https://go.microsoft.com/fwlink/?LinkId=733558
 // for the documentation about the tasks.json format
 {
-	"version": "2.0.0",
-	"tasks": [
-		{
-			"type": "npm",
-			"script": "watch",
-			"problemMatcher": "$tsc-watch",
-			"isBackground": true,
-			"presentation": {
-				"reveal": "never"
-			},
-			"group": {
-				"kind": "build",
-				"isDefault": true
-			}
-		}
-	]
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "typescript",
+      "tsconfig": "tsconfig.json",
+      "problemMatcher": ["$tsc"],
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    }
+  ]
 }

.vscodeignore

@@ -19,6 +19,6 @@ CONTRIBUTORS.md
 tsconfig.json
 tsconfig.build.json
 package-lock.json
-dist/*.map
+dist/**/*.map
 
 node_modules/

CONTRIBUTING.md

@@ -4,7 +4,7 @@ Thank you for showing interest in Junbae-mode and we appreciate any contribution
 
 ## Report a Bug or Feature
 
-Whenever you find something which is not working properly, please first search the repository's issue page and make sure it's not reported by someone else already.
+Whenever you find something that is not working properly, please first search the repository's issue page and make sure it's not reported by someone else already.
 
 Before creating an issue, check the `Issue Template` for guidelines. Provide as much detail as possible.
 
@@ -28,7 +28,7 @@ git checkout -b [branch name or issue number]
 
 ```sh
 # example
-git commit -m "feat:~~"
+git commit -m "your message"
 ```
 
 </br>
@@ -50,10 +50,11 @@ git push origin [branch name or issue number]
 ## Commit Convention
 
 ```
-feat: new feature for the user, not a new feature for build script
+breaking: top-level version bump. used for major framework changes or large-scale project deployments.
+feat: new feature for the user, not a new feature for building script
 fix: bug fix for the user, not a fix to a build script
 docs: changes to the documentation
-style: formatting, missing semi colons, etc; no production code change
+style: formatting, missing semi-colons, etc; no production code change
 refactor: refactoring production code, eg. renaming a variable
 test: adding missing tests, refactoring tests; no production code change
 chore: updating grunt tasks etc; no production code change

README-ko.md

@@ -1,40 +1,44 @@
 <div align="center">
   <a href="https://marketplace.visualstudio.com/items?itemName=JunbaeJs.junbae-mode&ssr=false#overview">
-    <img src="images/junbae_logo.png" height="128">
+    <img alt="junbae logo" src="images/junbae-logo.png" height="128">
     <h1 align="center">Junbae Mode</h1>
   </a>
 </div>
 
 <div align="center">
   <a aria-label="License" href="https://github.com/JunbaeJs/junbae-mode/blob/main/LICENSE">
-    <img alt="" src="https://img.shields.io/npm/l/next.svg?style=for-the-badge&labelColor=000000">
+    <img alt="LICENSE" src="https://img.shields.io/npm/l/next.svg?style=for-the-badge&labelColor=000000">
   </a>
   <a aria-label="Join the community on GitHub" href="https://github.com/JunbaeJs/junbae-mode">
-    <img alt="" src="https://img.shields.io/badge/Junbae%20Mode%20-blueviolet.svg?style=for-the-badge&logo=Github&labelColor=000000&logoWidth=20">
+    <img alt="JUNBAE MODE" src="https://img.shields.io/badge/Junbae%20Mode%20-blueviolet.svg?style=for-the-badge&logo=Github&labelColor=000000&logoWidth=20">
   </a>
 </div>
 
 ## Getting Started
+
+<img alt="Junbae Mode Example" src="images/junbae-mode-example.gif" height="250">
+
 키보드를 활용해 타이핑을 할 때마다 귀여운 준배가 당신과 함께 합니다.<br/>
 지루하고 따분한 코딩인생, 준배의 랜선 이모/삼촌이 되어 극복해보세요.<br/>
-모드에 따라 다양한 준배의 모습을 구경할 수 있어요! 
+모드에 따라 다양한 준배의 모습을 구경할 수 있어요!
 
 마켓플레이스에서 [준배모드](https://marketplace.visualstudio.com/items?itemName=JunbaeJs.junbae-mode&ssr=false#overview)를 다운받아 사용해보세요!
 
 ## Who is Junbae?
 
+<img alt="Junbae.D.Caique" src="images/junbae.jpg" height="400">
+
 저희의 마스코트인 아주아주 귀여운 준배를 소개합니다!<br/>
 준배는 카이큐 앵무새이고, 아주 귀엽죠.<br/>
 주황색 머리와 하얀색 배, 초록색 등을 가진 아주 귀여운 앵무새에요. <br/>
 준배는 [Arthur Hwang](https://github.com/changchanghwang)의 반려앵무이고, 여자아이에요.<br/>
-23년 12월 3일에 태어나, 이제 1살이 되었죠.<br/> 
+23년 12월 3일에 태어나, 이제 1살이 되었죠.<br/>
 그리고 아주 귀엽고, 귀엽고 또 귀엽습니다. <br/>
 
 준배의 귀여운 매력에 빠져, 저희는 코딩할 때도 준배를 떠올리는 날들이 많았습니다.<br/>
 그래서 코딩을 하면 준배를 볼 수 있도록 준배모드를 만들었어요!<br/>
 여러분도 준배의 귀여움에 같이 빠져보세요!
 
-
 ## Who is using Junbae Mode?
 
 - 코딩을 하면서 귀여운 준배의 매력에 빠지고 싶으신 분!
@@ -43,17 +47,18 @@
 - 회사에서 관심받고 싶으신 분!
 
 ## Warning
+
 준배는 여러분들의 개발을 효율적으로 돕거나 실력을 향상시켜 주지는 않습니다.<br/>
 준배에게 빠져 해야할 일을 잊지 않도록 주의가 필요합니다.
 
 하지만 귀여웠죠?
 
-
 ## Contributing
 
 준배모드에 기여하고 싶으신 분은 저희의 [CONTRIBUTING.md](/CONTRIBUTING.md) 문서를 확인해주세요!
 
 ## Authors
+
 - [Arthur Hwang](https://github.com/changchanghwang)
 - [Myunggyuns](https://github.com/myunggyuns)
 - [Sunnieee](https://github.com/sunnieeeYoon)

README.md

@@ -1,21 +1,23 @@
 <div align="center">
   <a href="https://marketplace.visualstudio.com/items?itemName=JunbaeJs.junbae-mode&ssr=false#overview">
-    <img src="images/junbae_logo.png" height="128">
+    <img alt="junbae logo" src="images/junbae-logo.png" height="128">
     <h1 align="center">Junbae Mode</h1>
   </a>
 </div>
 
 <div align="center">
   <a aria-label="License" href="https://github.com/JunbaeJs/junbae-mode/blob/main/LICENSE">
-    <img alt="" src="https://img.shields.io/npm/l/next.svg?style=for-the-badge&labelColor=000000">
+    <img alt="LICENSE" src="https://img.shields.io/npm/l/next.svg?style=for-the-badge&labelColor=000000">
   </a>
   <a aria-label="Join the community on GitHub" href="https://github.com/JunbaeJs/junbae-mode">
-    <img alt="" src="https://img.shields.io/badge/Junbae%20Mode%20-blueviolet.svg?style=for-the-badge&logo=Github&labelColor=000000&logoWidth=20">
+    <img alt="JUNBAE MODE" src="https://img.shields.io/badge/Junbae%20Mode%20-blueviolet.svg?style=for-the-badge&logo=Github&labelColor=000000&logoWidth=20">
   </a>
 </div>
 
 ## Getting Started
 
+<img alt="Junbae Mode Example" src="images/junbae-mode-example.gif" height="250">
+
 Whenever you type, the adorable Junbae will be with you.<br/>
 Overcome the dull coding life by becoming Junbae's aunt/uncle.<br/>
 You can enjoy various appearances of Junbae depending on the mode!
@@ -24,6 +26,8 @@ Download and try [Junbae Mode](https://marketplace.visualstudio.com/items?itemNa
 
 ## Who is Junbae?
 
+<img alt="Junbae.D.Caique" src="images/junbae.jpg" height="400">
+
 Let us introduce our mascot, the incredibly cute Junbae!<br/>
 Junbae is a caique parrot, and oh so adorable.<br/>
 With an orange head, white belly, and green feathers, Junbae is an incredibly cute parrot.<br/>
@@ -41,6 +45,7 @@ Come and immerse yourself in the adorable allure of Junbae together!
 - Those who want to be noticed at work!
 
 ## Warning
+
 Junbae doesn't directly help you with your development or improve your skills.<br/>
 Be careful not to get too caught up with Junbae and forget your tasks.
 
@@ -51,7 +56,7 @@ But isn't it adorable?
 If you want to contribute to Junbae Mode, please check our [CONTRIBUTING.md](/CONTRIBUTING.md) document!
 
 ## Authors
+
 - [Arthur Hwang](https://github.com/changchanghwang)
 - [Myunggyuns](https://github.com/myunggyuns)
 - [Sunnieee](https://github.com/sunnieeeYoon)
-