-
-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into production
- Loading branch information
Showing
104 changed files
with
2,198 additions
and
1,890 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# https://github.com/browserslist/browserslist#browserslistrc | ||
|
||
last 2 versions | ||
> 0.2% | ||
not dead |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,66 +1,55 @@ | ||
# How to Contribute | ||
|
||
We'd like to thank you for sparing time to improve this project! Here are some guidelines for contributing: | ||
:tada: We really appreciate you taking the time to improve this project! :tada: | ||
|
||
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 confusing, 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][pr-issue] issue to discuss whether your idea fits the project. | ||
|
||
## Basic Process | ||
|
||
Generally, contribute to the project by: | ||
Basically, you can follow these steps to complete the contribution. | ||
|
||
1. Fork this project on GitHub and clone it locally. | ||
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 | ||
2. Create a new branch from the default branch and give it a descriptive name | ||
(format: `feature/<add-new-feat>` or `fix/<fix-a-bug>`). | ||
3. After completing development, create a [Conventional Commit][cc] with git. | ||
(See also: ["Verify the commits"](#verify-the-commits)) | ||
4. Create a [Pull Request][gh-pr]. | ||
|
||
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: | ||
## Make sure you can pass the CI tests | ||
|
||
```console | ||
$ npm i | ||
``` | ||
|
||
During JavaScript development, real-time debugging can be performed through the following commands: | ||
|
||
Firstly, start a Jekyll server: | ||
This project has [CI][ci] turned on. In order for your [PR][gh-pr] to pass the test, | ||
please read the following. | ||
|
||
### Check the core functionality | ||
|
||
```console | ||
$ bash tools/run | ||
bash ./tools/test | ||
``` | ||
|
||
And then open a new terminal tab and run: | ||
### Check the SASS syntax style | ||
|
||
```console | ||
# Type 'Ctrl + C' to stop | ||
$ npx gulp dev | ||
npm test | ||
``` | ||
|
||
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 | ||
### Verify the commits | ||
|
||
If you want to make sure your commits pass the CI check, you can refer to the following steps. | ||
Before you create a git commit, please complete the following setup. | ||
|
||
Install `commitlint` & `husky`: | ||
|
||
```console | ||
$ npm i -g @commitlint/{cli,config-conventional} husky | ||
npm i -g @commitlint/{cli,config-conventional} husky | ||
``` | ||
|
||
And then enable `husky`: | ||
|
||
```console | ||
$ husky install | ||
husky install | ||
``` | ||
|
||
--- | ||
|
||
:tada: Your volunteering will make the open-source world more beautiful, thanks again! :tada: | ||
[pr-issue]: https://github.com/cotes2020/jekyll-theme-chirpy/issues/new?labels=enhancement&template=feature_request.md | ||
[gh-pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests | ||
[cc]: https://www.conventionalcommits.org/ | ||
[ci]: https://en.wikipedia.org/wiki/Continuous_integration |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
name: Help Wanted | ||
about: Need help that is not covered in the tutorial | ||
labels: 'help wanted' | ||
--- | ||
|
||
**NOTE:** Before you start, the following should be completed. | ||
|
||
- Read [tutorial][tutorial] to understand the usage and the correct effect of functional design. | ||
- Make sure no [similar issue(including closed ones)][issues] exists. | ||
- Try to find the answer on [Jekyll Forum][forum] and [StackOverflow][stack_overflow]. | ||
|
||
[tutorial]: https://cotes2020.github.io/chirpy-demo/categories/tutorial/ | ||
[issues]: https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue | ||
[forum]: https://talk.jekyllrb.com/ | ||
[stack_overflow]: https://stackoverflow.com/questions/tagged/jekyll | ||
|
||
## Description | ||
|
||
<!-- Please describe your need in detail. --> | ||
|
||
## Operations you have already tried | ||
|
||
<!-- Describe the effort you went through. --> | ||
|
||
## Logs/Screenshots | ||
|
||
<!-- If applicable, add logs/screenshots to help explain your problem. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Security Policy | ||
|
||
## Supported Versions | ||
|
||
| Version | Supported | | ||
|---------| ------------------ | | ||
| 5.x | :white_check_mark: | | ||
| < 5.0.0 | :x: | | ||
|
||
## Reporting a Vulnerability | ||
|
||
If you find a vulnerability, please report it to `cotes.chung@gmail.com`. We will try our best to respond within a week. Thank you for your time! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
name: "CodeQL" | ||
|
||
on: | ||
push: | ||
paths: ["**.js"] | ||
pull_request: | ||
paths: ["**.js"] | ||
schedule: | ||
- cron: "0 0 * * 5" | ||
|
||
jobs: | ||
analyze: | ||
name: Analyze | ||
runs-on: ubuntu-latest | ||
permissions: | ||
actions: read | ||
contents: read | ||
security-events: write | ||
|
||
strategy: | ||
fail-fast: false | ||
matrix: | ||
language: ["javascript"] | ||
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v3 | ||
|
||
# Initializes the CodeQL tools for scanning. | ||
- name: Initialize CodeQL | ||
uses: github/codeql-action/init@v2 | ||
with: | ||
languages: "${{ matrix.language }}" | ||
|
||
# Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java). | ||
# If this step fails, then you should remove it and run the build manually (see below) | ||
- name: Autobuild | ||
uses: github/codeql-action/autobuild@v2 | ||
|
||
- name: Perform CodeQL Analysis | ||
uses: github/codeql-action/analyze@v2 | ||
with: | ||
category: "/language:${{ matrix.language }}" |
Oops, something went wrong.