Sync with upstream

.commitlintrc.json

@@ -0,0 +1,8 @@
+{
+  "rules": {
+    "body-max-line-length": [
+      0,
+      "always"
+    ]
+  }
+}

.editorconfig

@@ -2,10 +2,13 @@ root = true
 
 [*]
 charset = utf-8
-# 2 space indentation
 indent_style = space
 indent_size = 2
 trim_trailing_whitespace = true
 # Unix-style newlines with a newline ending every file
 end_of_line = lf
 insert_final_newline = true
+
+
+[*.js]
+indent_size = 4

.github/CODE_OF_CONDUCT.md

@@ -70,4 +70,4 @@ available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.h
 For answers to common questions about this code of conduct, see
 <https://www.contributor-covenant.org/faq>
 
-[homepage]: https://www.contributor-covenant.org
+[homepage]: https://www.contributor-covenant.org

.github/CONTRIBUTING.md

@@ -1,16 +1,66 @@
 # How to Contribute
 
-I want to thank you for sparing a time to improve this project! Here are some guidelines for contributing：
+We'd like to thank you for sparing time to improve this project! Here are some guidelines for contributing：
 
-To ensure that the blog design is not confused, this project does not accept suggestions for design changes, such as color scheme, fonts, typography, etc. If your request is about an enhancement, it is recommended to first submit a [`Feature Request`](https://github.com/cotes2020/jekyll-theme-chirpy/issues/new?labels=enhancement&template=feature_request.md) issue to discuss whether your idea fits the project. 
+To ensure that the blog design is not confused, this project does not accept suggestions for design changes, such as color scheme, fonts, typography, etc. If your request is about an enhancement, it is recommended to first submit a [_Feature Request_](https://github.com/cotes2020/jekyll-theme-chirpy/issues/new?labels=enhancement&template=feature_request.md) issue to discuss whether your idea fits the project.
+
+## Basic Process
 
 Generally, contribute to the project by:
 
 1. Fork this project on GitHub and clone it locally.
-2. Create a new branch from `master` and give it a descriptive name (e.g., `my-new-feature`, `fix-a-bug`).
-3. After completing the development, commit and push to remote.
-4. Submit a new pull request.
+2. Create a new branch from the default branch and give it a descriptive name (format: `feature/<add-new-feat>` / `fix/<fix-a-bug>`).
+3. After completing the development, submit a new _Pull Request_. Note that the commit message must follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), otherwise it will fail the PR check.
+
+## Modifying JavaScript
+
+If your contribution involves JavaScript modification, please read the following sections.
+
+### Inline Scripts
+
+If you need to add comments to the inline JavaScript (the code between the HTML tags `<script>` and `</script>`), please use `/* */` instead of two slashes `//`. Because the HTML will be compressed by [jekyll-compress-html](https://github.com/penibelst/jekyll-compress-html) during deployment, but it cannot handle the `//` properly, which will disrupt the structure of the compressed HTML.
+
+### External Scripts
+
+If you need to add/change/delete the JavaScript in the directory `_javascript/`, setting up [`Node.js`](https://nodejs.org/) and [`npx`](https://www.npmjs.com/package/npx) is a requirement. And then install the development dependencies:
+
+```console
+$ npm i
+```
+
+During JavaScript development, real-time debugging can be performed through the following commands:
+
+Firstly, start a Jekyll server:
+
+```console
+$ bash tools/run.sh
+```
+
+And then open a new terminal tab and run:
+
+```console
+# Type 'Ctrl + C' to stop
+$ npx gulp dev
+```
+
+After debugging, run the command `npx gulp` (without any argument) will automatically output the compressed files to the directory `assets/js/dist/`.
+
+## Verify the commit messages
+
+If you want to make sure your commits pass the CI check, you can refer to the following steps.
+
+Install `commitlint` & `husky`:
+
+```console
+$ npm i -g @commitlint/{cli,config-conventional} husky
+```
+
+And then enable `husky`:
+
+```console
+$ husky install
+```
 
 ---
 
-:tada: Your volunteering will make the open source world more beautiful, thanks again! :tada:
+:tada: Your volunteering will make the open-source world more beautiful, thanks again! :tada:

.github/FUNDING.yml

@@ -1,3 +1,2 @@
-custom:
-  - https://www.buymeacoffee.com/coteschung
-  - https://cotes.gitee.io/alipay-wechat-donation
+ko_fi: coteschung
+custom: https://sponsor.cotes.page

.github/ISSUE_TEMPLATE/bug_report.md

@@ -6,12 +6,15 @@ about: Create a report to help us improve
 <!-- NOTE: Please maintain all sections, otherwise the issue will be automatically closed :) -->
 
 ## Checklist
-<!-- Please complete the following list of tasks, and then check it by change the "[ ]" to "[x]" -->
-- [ ] I have read the [tutorials](https://chirpy.cotes.info/categories/tutorial/) and know the correct effect of the functional design.
-- [ ] There are no similar reports on existing issues (including closed ones).
-- [ ] I found the bug on the latest code of `master` branch.
+
+<!-- Please complete the following list of tasks, and then check it by changing the "[ ]" to "[x]" -->
+
+- [ ] I have read the [tutorials](https://cotes2020.github.io/chirpy-demo/categories/tutorial/) and know the correct effect of the functional design.
+- [ ] There are no similar reports on [existing issues](https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue) (including closed ones).
+- [ ] I found the bug on the latest code of the `master` branch.
 
 ## Describe the bug
+
 <!-- A clear and concise description of what the bug is. -->
 
 ### To Reproduce
@@ -25,19 +28,25 @@ Steps to reproduce the behavior:
 -->
 
 ### Expected behavior
+
 <!-- A clear and concise description of what you expected to happen. -->
 
 ### Screenshots
+
 <!-- If applicable, add screenshots to help explain your problem. -->
 
-### Software
-<!-- Please complete the following information -->
-- Ruby version: <!-- by running: `ruby -v` -->
-- Gem version: <!-- by running: `gem -v`-->
-- Bundler version: <!-- by running: `bundle -v`-->
-- Jekyll version: <!-- by running: `bundle list | grep " jekyll "` -->
+### Environment
+
+| Command                           | Version |
+|-----------------------------------|---------|
+| `ruby -v`                         |         |
+| `gem -v`                          |         |
+| `bundle -v`                       |         |
+| `bundle exec jekyll -v`           |         |
+| `bundle info jekyll-theme-chirpy` |         |
 
 ### Desktop
+
 <!-- If necessary, uncomment and fill in the following list:
 - OS: [e.g. macOS 10.15.6]
 - Browser: [e.g. Chrome 85.0.4183.83 (64-bit)]

.github/ISSUE_TEMPLATE/feature_request.md

@@ -7,9 +7,10 @@ labels: enhancement
 <!-- NOTE: Please maintain all sections, otherwise the issue will be automatically closed :) -->
 
 ## Checklist
-<!-- Please complete the following list of tasks, and then check it by change the "[ ]" to "[x]" -->
+
+<!-- Please complete the following list of tasks, and then check it by changing the "[ ]" to "[x]" -->
 - [ ] I have read the [contributing guidelines](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/CONTRIBUTING.md).
-- [ ] There are no similar request on existing issues (including closed ones).
+- [ ] There is no similar request on [existing issues](https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue) (including closed ones).
 - [ ] I have read the [project progress](https://github.com/cotes2020/jekyll-theme-chirpy/projects) and know the current progress of the project.
 - [ ] I was in the `master` branch of the latest code.
 

.github/ISSUE_TEMPLATE/question.md

@@ -1,19 +1,20 @@
 ---
 name: Question
-about: Ask what ever you want
+about: Ask whatever you want
 labels: question
 ---
 
 <!-- NOTE: Please maintain all sections, otherwise the issue will be automatically closed :) -->
 
 ## Checklist
 
-<!-- Please complete the following list of tasks, and then check it by change the "[ ]" to "[x]" -->
+<!-- Please complete the following list of tasks, and then check it by changing the "[ ]" to "[x]" -->
 
-- [ ] I have read the [tutorials](https://chirpy.cotes.info/categories/tutorial/) and know the correct effect of the functional design.
-- [ ] There are no similar question on existing issues (including closed ones).
-- [ ] I searched the Internet for related problems, but still couldn't solve it.
-- [ ] My question is based on the latest code of `master` branch.
+- [ ] I have read the [newlest tutorials](https://cotes2020.github.io/chirpy-demo/categories/tutorial/) and know the correct effect of the functional design.
+- [ ] There is no similar question on [existing issues](https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue) (including closed ones).
+- [ ] I have tried to find the answer on [Jekyll Forum](https://talk.jekyllrb.com/) and [StackOverflow](https://stackoverflow.com/questions/tagged/jekyll).
+- [ ] My question is based on the latest code of the `master` branch.
 
 ## Description
-<!-- Please describe your question in detial. -->
+
+<!-- Please describe your question in detail. -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,14 +1,14 @@
 ## Description
 
-<!-- 
+<!--
 Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
--->
 
 e.g. Fixes #(issue)
+-->
 
 ## Type of change
 
-<!-- 
+<!--
 Please select the desired item checkbox and change it to "[x]", then delete options that are not relevant.
 -->
 - [ ] Bug fix (non-breaking change which fixes an issue)
@@ -18,27 +18,25 @@ Please select the desired item checkbox and change it to "[x]", then delete opti
 
 ## How has this been tested
 
-<!-- 
+<!--
 Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
 -->
 
-- [ ] I have run `bash ./tools/test.sh --build` (at the root of the project) locally and passed
+- [ ] I have run `bash ./tools/test.sh` (at the root of the project) locally and passed
 - [ ] I have tested this feature in the browser
 
 ### Test Configuration
 
-- Browerser type & version:
+- Browser type & version:
 - Operating system:
-- Bundler version:
-- Ruby version:
-- Jekyll version:
+- Ruby version: <!-- by running: `ruby -v` -->
+- Bundler version: <!-- by running: `bundle -v`-->
+- Jekyll version: <!-- by running: `bundle list | grep " jekyll "` -->
 
 ### Checklist
+
 <!-- Select checkboxes by change the "[ ]" to "[x]" -->
-- [ ] My code follows the [Google style guidelines](https://google.github.io/styleguide/)
-- [ ] I have performed a self-review of my own code
-- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have performed a self-review of my code
+- [ ] I have commented on my code, particularly in hard-to-understand areas
 - [ ] I have made corresponding changes to the documentation
 - [ ] My changes generate no new warnings
-- [ ] I have added tests that prove my fix is effective or that my feature works
-- [ ] Any dependent changes have been merged and published in downstream modules

.github/workflows/ci.yml

@@ -1,47 +1,41 @@
-name: 'Continuous Integration'
+name: 'CI'
 on:
   push:
     branches-ignore:
-      - 'production'
+      - 'release/**'
+      - 'docs'
     tags-ignore:
-      - '*'
+      - '**'
     paths-ignore:
       - '.github/**'
       - '!.github/workflows/ci.yml'
       - '.travis.yml'
       - '.gitignore'
-      - 'docs/**'
       - 'README.md'
       - 'LICENSE'
   pull_request:
     paths:
       - '**'
 
 jobs:
-  ci:
-    runs-on: ${{ matrix.os }}
+  build:
+    runs-on: ubuntu-latest
+
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest]
+        ruby: [2.5, 2.6, 2.7, 3]
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0  # for posts's lastmod
 
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
-      - name: Build Site
-        env:
-          JEKYLL_ENV: production
-        run: |
-          bundle exec jekyll b
-
       - name: Test Site
-        run: |
-          bash tools/test.sh
+        run: bash tools/test.sh

.github/workflows/commitlint.yml

@@ -0,0 +1,11 @@
+name: Lint Commit Messages
+on: pull_request
+
+jobs:
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: wagoid/commitlint-github-action@v4

.github/workflows/issue-interceptor.yml

@@ -0,0 +1,18 @@
+name: Intercept bad issues
+
+on:
+  issues:
+    types: [opened, edited]
+
+jobs:
+  auto_close_issues:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+      - name: Auto close issues that did not follow template
+        uses: lucasbento/[email protected]
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          issue-close-message: ":wave: Hi @${issue.user.login},\n\nThis issue is being automatically closed because it does not follow the issue template. Please DO NOT open another similar issue, try to edit the current issue according to the template, then it will be reopened automatically."
+          closed-issues-label: "🙁 Not following issue template"