From 195cb565ce93eb207b153f9f383d5bd458147bc0 Mon Sep 17 00:00:00 2001 From: Eltrac Koalar Date: Sun, 3 May 2020 20:18:26 +0800 Subject: =?UTF-8?q?:wastebin:=20Del:=20=E7=A7=BB=E9=99=A4=E8=BF=87?= =?UTF-8?q?=E6=9C=9F=E4=B8=94=E6=97=A0=E7=94=A8=E7=9A=84=E8=8B=B1=E6=96=87?= =?UTF-8?q?=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/README-en.md | 58 ------------------------------------------------------- 1 file changed, 58 deletions(-) delete mode 100644 docs/README-en.md (limited to 'docs') diff --git a/docs/README-en.md b/docs/README-en.md deleted file mode 100644 index 0bf0d98..0000000 --- a/docs/README-en.md +++ /dev/null @@ -1,58 +0,0 @@ -![](/banner.jpg) -![](https://img.shields.io/badge/build-passing-brightgreen.svg?style=flat-square) -![](https://img.shields.io/badge/made%20with-%E2%9D%A4-ff69b4.svg?style=flat-square) -![](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square) -![](https://img.shields.io/badge/for-Typecho-blueviolet.svg?style=flat-square) -![](https://img.shields.io/badge/version-1.2.1-red.svg?style=flat-square) -> 🙌 Born to be the Miracles. - -Language: [简体中文](/README.md) | English - -**Notice: This theme is only for [Typecho](https://github.com/typecho/typecho).** -# Feature -- Responsive Web design -- Pjax -- LazyLoad -- Code Highlight by Prism.js -- Change font-family and font-size when viewing pages -- Use emotional pictures in comments -- Live2d -- A nice dark theme -- Two interesting filters -- Two kinds of Nav -- Custom excerpt when posting -- Twenty random banner for articles -- ~~Lightweight (4MB)~~ - -# Usage -- Star, please! -- Download the latest release. -- Change the name of the folder into `Miracles` -- Put it into `usr/themes` -- Start using after reading the [wiki](https://github.com/BigCoke233/miracles/wiki) -> Sorry, there's no English edition of the wiki now. Maybe you can help me. - -# Thanks! -- [jQuery](https://github.com/jquery/jquery) -- [FancyBox](https://github.com/fancyapps/fancybox) -- [Prism.js](https://github.com/PrismJS/prism) -- [Nprogress](https://github.com/rstacruz/nprogress) -- [OwO](https://github.com/DIYgod/OwO) -- [Pjax](https://github.com/defunkt/jquery-pjax) -- [LazyLoad](https://github.com/tuupola/lazyload) -- [Pangu.js](https://github.com/vinta/pangu.js) - -[@ohmyga233](https://github.com/ohmyga233) | -[@AlanDecode](https://github.com/AlanDecode) | -[@gfwyuexia](https://github.com/gfwyuexia) | -[@jrotty](https://github.com/jrotty) - -# Links -Demo: [My Blog](https://guhub.cn) -Introduction: [Miracles —— 生为奇迹](https://guhub.cn/p/miracles.html) -Change-log: [change-log.md](/docs/change-log.md) -Plan: [plan.md](/docs/plan.md) -> All above is in Chinese. - -# Lincense -© [Eltrac](https://github.com/BigCoke233/) | Under MIT License. -- cgit v1.2.3 From 972afcf131a2eda4ad550938f8c6df4672c88159 Mon Sep 17 00:00:00 2001 From: Eltrac Koalar Date: Sun, 3 May 2020 20:20:11 +0800 Subject: =?UTF-8?q?=F0=9F=93=8B=20Docs:=201.5.4=20=E6=9B=B4=E6=96=B0?= =?UTF-8?q?=E6=97=A5=E5=BF=97?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/change-log.md | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'docs') diff --git a/docs/change-log.md b/docs/change-log.md index 5e813aa..3ced322 100644 --- a/docs/change-log.md +++ b/docs/change-log.md @@ -1,6 +1,15 @@ # 更新日志 这里是 Miracles 主题的更新日志，每个发行版以及开发版的更新内容都会在这里记录，历史版本以及最新版本的下载请到 [Releases](https://github.com/BigCoke233/miracles/releases) 页面，若在使用中有任何问题，请在 issues 中提出或 Pull requests，感谢！ +## Ver.1.5.4 Your best nightmare + +- 增加：适配夜间模式的图标 +可在根目录下创建 faviconDark.ico，如果这个文件存在而系统又为深色模式的时候，就将 favicon 替换成这个文件 +- 优化：移动端下，追番项目一行显示两个 +- 优化：优化夜间模和日落模式 +- 优化：导航栏 :hover 毛玻璃效果优化 +- 移除：提交评论时小电视动画 + ## Ver.1.5.2 Slow Down - 增加：短链接 `[notice][/notice]`，相当于带有 role="note" 的 div -- cgit v1.2.3 From 82628c555ff5e5fae4bc7f45f52dc4070c9e567b Mon Sep 17 00:00:00 2001 From: Eltrac Koalar Date: Mon, 4 May 2020 08:14:25 +0800 Subject: =?UTF-8?q?=F0=9F=97=82=20Docs:=20Project-management.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/project-management.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 docs/project-management.md (limited to 'docs') diff --git a/docs/project-management.md b/docs/project-management.md new file mode 100644 index 0000000..78289aa --- /dev/null +++ b/docs/project-management.md @@ -0,0 +1,61 @@ +# 项目管理 + +这篇文档记录一些 Miracles 主题在更新维护过程中一些不成文的习惯，写在文档里当作一种规范。 + +## Commit + +在提交 commit 的时候，需要书写 message，通常来说，Miracles 主题所有的 commit message 都应该按照一下格式书写 + +``` +:emoji: : +``` + +这里面提到的几个部分不太好直接理解，以下是对他们的解释 + +- `:emoji:`：就是 emoji 字符，应选用和这个 commit 内容有关的 emoji，但主要是为了美观 +- ``：这个 sign 用来提醒用户这个 commit 更新了什么类型的内容，通常用一下的字符替换 + - `Add`：顾名思义，用在添加新内容/功能的 commit 里 + - `Perf`：这是 perfect 的缩写，通常用于对现有功能进行优化的 commit 里 + - `Del`：即 Delete，表示移除了某些内容 + - `Docs`：即 Documents，表示对某些文档进行了修改，不涉及主体代码 + - `Update`：用于一些无法被归类的 commit，例如：修改版本号 +- ``：意为总结，就是对更新的内容进行简短的阐述，作为摘要 + +例子：`📐 Perf: 优化了文章盒子的边距` + +这就是一个普通 commit message 的组成，通常只适用于 message 的 header 部分，body 部分是可有可无的，除非你觉得 header 无法完整地表达这次 commit 更新的内容， +就可以在 body 里对这次更新内容进行详细地阐述，没有固定的格式，表述清楚即可。 + +## 版本号 + +如果你仔细观察 Miracles 主题的 release 页面，或者是每个版本的更新日志，你会看到它们通常是这样的 + +``` +:emoji: Ver. +``` + +- `:emoji`：就是 emoji 字符，通常选用和这次更新**主题**相关的 emoji +- ``：版本号，发行版和开发版的版本号有区别 + - 发行版：通常只有发行版才会有正式的版本号，类似`1.5.2`，`1` 增加代表一次超大更新(几乎重写的那种吧)，`5`增加代表一次大更新(增加了许多新功能)，`2`增加代表补丁这样的小更新(通常只有修复和优化) + - 开发版：开发版的版本号通常以`v`开头，之后是日期，如果这一天有多次开发版更新，则用`A-Z`来区分，例如：`v20200503A`、`v20191223B` +- ``：这个版本的名字，一般是根据更新内容和这次更新的主题来命名 + +> 通常来说，开发版的更新不会写入正式的更新日志（change-log.md） + +## issue + +Miracles 主题有三个自带的 issue 模板，分别是： + +- 问题报告（label：问题） +- 想法建议（label：优化） +- 需要帮助（label：求助） + +正常来说，这三个模板能满足大多数人的要求，并且如果他们按照模板书写 issue 会让开发者更方便。 + +满足以下条件的 issue，会被 close： + +- 问题已被完美解决（label：解决） +- 问题根本不存在（label：错误） +- 这个想法没有必要（label：拒绝） +- 存在相同的内容（label：重复） + -- cgit v1.2.3