You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+6-7Lines changed: 6 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,12 @@
1
-
# Description
1
+
##Description
2
2
3
3
<!--
4
4
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.
5
5
-->
6
6
7
-
Fixes #(issue)
7
+
e.g. Fixes #(issue)
8
8
9
-
10
-
## Type of change
9
+
**Type of change**
11
10
12
11
<!--
13
12
Please select the desired item checkbox and change it to "[x]", then delete options that are not relevant.
@@ -17,7 +16,7 @@ Please select the desired item checkbox and change it to "[x]", then delete opti
17
16
-[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
18
17
-[ ] Documentation update
19
18
20
-
# How Has This Been Tested?
19
+
##How has this been tested?
21
20
22
21
<!--
23
22
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
@@ -26,7 +25,7 @@ Please describe the tests that you ran to verify your changes. Provide instructi
26
25
-[ ] I have run `bash ./tools/build.sh && bash ./tools/test.sh` (at the root of the project) locally and passed
27
26
-[ ] I have tested this feature in the browser
28
27
29
-
## Test Configuration
28
+
**Test Configuration**
30
29
31
30
* Browerser type & version:
32
31
* Operating system:
@@ -35,7 +34,7 @@ Please describe the tests that you ran to verify your changes. Provide instructi
35
34
* Jekyl version:
36
35
37
36
38
-
# Checklist:
37
+
##Checklist:
39
38
<!-- Select checkboxes by change the "[ ]" to "[x]" -->
40
39
-[ ] My code follows the [Google style guidelines](https://google.github.io/styleguide/)
41
40
-[ ] I have performed a self-review of my own code
and replace the `USER` above to your GitHub username.
69
+
And replace the `USER` above to your GitHub username.
70
70
71
71
The first time you run or build the project on local machine, perform the installation of Jekyll plugins. Go to the root of repo and run:
72
72
@@ -82,7 +82,7 @@ $ bundle install
82
82
83
83
### Directory Structure
84
84
85
-
The main files and related brief introductions are listed below.
85
+
The main files and related brief introductions are listed below:
86
86
87
87
```sh
88
88
jekyll-theme-chirpy/
@@ -113,8 +113,9 @@ jekyll-theme-chirpy/
113
113
114
114
As mentioned above, some files or directories should be removed from your repo:
115
115
116
-
- .travis.yml
117
-
- .github
116
+
```terminal
117
+
$ rm -rf .travis.yml .github _posts/*
118
+
```
118
119
119
120
120
121
### Configuration
@@ -164,7 +165,7 @@ Before the deployment begins, checkout the file `_config.yml` and make sure that
164
165
165
166
By deploying the site in this way, you're allowed to push the source code directly to the remote.
166
167
167
-
> **Note**: If you want to use any third-party Jekyll plugins that not in[this list](https://pages.github.com/versions/), stop reading the current approach and go to [*Option 2: Build locally*](#option-2-build-locally).
168
+
> **Note**: If you want to use any third-party Jekyll plugins that not on[this list](https://pages.github.com/versions/), stop reading the current approach and go to [*Option 2: Build locally*](#option-2-build-locally).
168
169
169
170
**1**. Rename the repository to:
170
171
@@ -202,7 +203,7 @@ it will automatically generates the *Latest Modified Date* and *Categories / Tag
202
203
203
204
#### Option 2: Build Locally
204
205
205
-
For security reasons, GitHub Pages runs on `safe` mode, which means the third-party Jekyll plugins or custom scripts won't work. If you want to use any another plugins that not in the [whitelist](https://pages.github.com/versions/), **you have to generate the site locally rather than on GitHub Pages**.
206
+
For security reasons, GitHub Pages runs on `safe` mode, which means the third-party Jekyll plugins or custom scripts won't work. If you want to use any other plugin that not on the [whitelist](https://pages.github.com/versions/), **you have to generate the site locally rather than on GitHub Pages**.
206
207
207
208
**1**. Browse to GitHub website, create a brand new repo named:
and replace the `USER` above to your GitHub username.
37
+
And replace the `USER` above to your GitHub username.
38
38
39
39
The first time you run or build the project on local machine, perform the installation of Jekyll plugins. Go to the root of repo and run:
40
40
@@ -47,7 +47,7 @@ $ bundle install
47
47
48
48
## Directory Structure
49
49
50
-
The main files and related brief introductions are listed below.
50
+
The main files and related brief introductions are listed below:
51
51
52
52
```sh
53
53
jekyll-theme-chirpy/
@@ -77,9 +77,9 @@ jekyll-theme-chirpy/
77
77
78
78
As mentioned above, some files or directories should be removed from your repo:
79
79
80
-
- .travis.yml
81
-
- .github
82
-
80
+
```terminal
81
+
$ rm -rf .travis.yml .github _posts/*
82
+
```
83
83
84
84
## Configuration
85
85
@@ -129,7 +129,7 @@ Before the deployment begins, checkout the file `_config.yml` and make sure that
129
129
130
130
By deploying the site in this way, you're allowed to push the source code directly to the remote.
131
131
132
-
> **Note**: If you want to use any third-party Jekyll plugins that not in[this list](https://pages.github.com/versions/), stop reading the current approach and go to [*Option 2: Build locally*](#option-2-build-locally).
132
+
> **Note**: If you want to use any third-party Jekyll plugins that not on[this list](https://pages.github.com/versions/), stop reading the current approach and go to [*Option 2: Build locally*](#option-2-build-locally).
133
133
134
134
**1**. Rename the repository to:
135
135
@@ -167,7 +167,7 @@ it will automatically generates the *Latest Modified Date* and *Categories / Tag
167
167
168
168
### Option 2: Build Locally
169
169
170
-
For security reasons, GitHub Pages runs on `safe` mode, which means the third-party Jekyll plugins or custom scripts won't work. If you want to use any another plugins that not in the [whitelist](https://pages.github.com/versions/), **you have to generate the site locally rather than on GitHub Pages**.
170
+
For security reasons, GitHub Pages runs on `safe` mode, which means the third-party Jekyll plugins or custom scripts won't work. If you want to use any other plugin that not on the [whitelist](https://pages.github.com/versions/), **you have to generate the site locally rather than on GitHub Pages**.
171
171
172
172
**1**. Browse to GitHub website, create a brand new repo named:
0 commit comments