From b22da9413403a3fc890dacfd8b50caa020c2f97a Mon Sep 17 00:00:00 2001 From: Cotes Chung <11371340+cotes2020@users.noreply.github.com> Date: Tue, 9 Jun 2020 12:32:33 +0800 Subject: [PATCH] Updated the docs. - Updated the build badge on ReadMe. - Improved the PR template. --- .github/PULL_REQUEST_TEMPLATE.md | 10 +++++----- README.md | 2 +- docs/README_zh-CN.md | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ccf56d4..9a0b847 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -23,10 +23,11 @@ Please select the desired item checkbox and change it to "[x]", then delete opti 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 --> -- [ ] Test A -- [ ] Test B +- [ ] I have run `bash ./tools/build.sh && bash ./tools/test.sh` (at the root of the project) locally and passed +- [ ] I have tested this feature in the browser + +## Test Configuration -**Test Configuration**: * Browerser type & version: * Operating system: * Bundler version: @@ -36,11 +37,10 @@ Please describe the tests that you ran to verify your changes. Provide instructi # Checklist: -- [ ] My code follows the style guidelines of this project +- [ ] 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 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 -- [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules \ No newline at end of file diff --git a/README.md b/README.md index fe4b713..93eaebf 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ 🌏 English • [简体中文](docs/README_zh-CN.md) -[![Build Status](https://github.com/cotes2020/jekyll-theme-chirpy/workflows/build/badge.svg?event=push)](https://github.com/cotes2020/jekyll-theme-chirpy/actions?query=event%3Apush) +[![Build Status](https://github.com/cotes2020/jekyll-theme-chirpy/workflows/build/badge.svg?branch=master&event=push)](https://github.com/cotes2020/jekyll-theme-chirpy/actions?query=branch%3Amaster+event%3Apush) [![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE) [![996.icu](https://img.shields.io/badge/link-996.icu-%23FF4D5B.svg)](https://996.icu) diff --git a/docs/README_zh-CN.md b/docs/README_zh-CN.md index 604c1ca..f0bdbe3 100644 --- a/docs/README_zh-CN.md +++ b/docs/README_zh-CN.md @@ -2,7 +2,7 @@ 🌏 [English](../README.md) • 简体中文 -[![Build Status](https://github.com/cotes2020/jekyll-theme-chirpy/workflows/build/badge.svg?event=push)](https://github.com/cotes2020/jekyll-theme-chirpy/actions?query=event%3Apush) +[![Build Status](https://github.com/cotes2020/jekyll-theme-chirpy/workflows/build/badge.svg?branch=master&event=push)](https://github.com/cotes2020/jekyll-theme-chirpy/actions?query=branch%3Amaster+event%3Apush) [![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE) [![996.icu](https://img.shields.io/badge/link-996.icu-%23FF4D5B.svg)](https://996.icu)