docs: improve documents

Author: adoyle-h

.chglog/CHANGELOG.tpl.md

@@ -4,11 +4,27 @@
 
 {{ if .Tag.Previous }}[Full Changes]({{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}){{ end }}
 
+{{ if .NoteGroups -}}
+{{ range .NoteGroups -}}
+### {{ .Title }}
+
+{{ range .Notes -}}
+{{ .Body }}
+{{  end }}
+{{  end }}
+{{- end -}}
+
 {{ range .CommitGroups -}}
 ### {{ .Title }}
 
 {{ range .Commits -}}
-- {{ if .Scope }}**{{ .Scope }}**: {{ end }}{{ .Subject }}
+- {{ if .Scope }}**{{ .Scope }}**: {{ end }}{{ .Subject }} [[{{.Hash.Short}}]({{$.Info.RepositoryURL}}/commit/{{.Hash.Long}})] 
+{{- if not (empty .Refs) }} ({{ range .Refs }}#{{ .Ref }} {{ end }}) {{- end }}
+{{- if not (empty .Body) }}
+  ```
+  {{ regexReplaceAll "\n" .Body "\n  " | abbrev 960 }}
+  ```
+{{ end }}
 {{ end }}
 {{ end -}}
 
@@ -27,14 +43,4 @@
 - {{ .Header }}
 {{ end }}
 {{ end -}}
-
-{{- if .NoteGroups -}}
-{{ range .NoteGroups -}}
-### {{ .Title }}
-
-{{ range .Notes }}
-{{ .Body }}
-{{ end }}
-{{ end -}}
-{{ end -}}
 {{ end -}}

CHANGELOG.md

@@ -2,19 +2,9 @@
 
 All notable changes to this project will be documented in this file.
 
-The format is inspired by [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
-
-## Change Types
-
-- Add: New features.
-- Fix: Bug fixes.
-- Change: Changes in existing functionality.
-- Breaking Change: Changes which incompatible with previous version in existing functionality
-- Deprecate: Features soon-to-be removed.
-- Remove: Features removed now.
-- Security: In case of vulnerabilities.
-- Doc: Documentation changes.
+The format is inspired by [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
+
+The versions follow the rules of [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 

Makefile

@@ -0,0 +1,10 @@
+.PHONY: bump-major bump-minor bump-patch
+
+bump-major:
+	./tools/bump major
+
+bump-minor:
+	./tools/bump minor
+
+bump-patch:
+	./tools/bump patch

README.md

@@ -70,8 +70,8 @@ Lobash helps to reduce the mental burden on developers.
 
 ## Versions
 
-Read [tags][].
-The versions follows the rules of [SemVer 2.0.0](http://semver.org/).
+Read [tags][] for verions.
+The versions follow the rules of [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html).
 
 ## [ChangeLog](./CHANGELOG.md)
 

README.zh.md

@@ -69,8 +69,8 @@ Lobash 能减少开发者的心智负担。
 
 ## 版本
 
-Read [tags][].
-The versions follows the rules of [SemVer 2.0.0](http://semver.org/).
+版本详见 [tags][]。
+版本命名遵守 [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html)。
 
 ## [变更日志 ChangeLog](./CHANGELOG.md)
 

tools/bump

@@ -18,21 +18,18 @@ SCRIPT_DIR="$(cd -P -- "$(dirname -- "$0")" && pwd -P)"
 readonly SCRIPT_DIR
 
 semver=$SCRIPT_DIR/../tmp/semver
+changelog=$SCRIPT_DIR/../CHANGELOG.md
 
-# shellcheck source=../src/internals/is_gnu_sed.bas
-. $SCRIPT_DIR/../src/internals/is_gnu_sed.bash
+_lobash.is_gnu_sed() {
+  sed --version 2>/dev/null | grep 'GNU sed' >/dev/null
+}
 
 if _lobash.is_gnu_sed; then
   sedi() { sed -i "$@"; }
 else
   sedi() { sed -i '' "$@"; }
 fi
 
-if [[ ! -f $semver ]]; then
-  curl -Lo "$semver" https://raw.githubusercontent.com/fsaintjacques/semver-tool/master/src/semver
-  chmod +x "$semver"
-fi
-
 update_changelog() {
   local next_ver=$1
 
@@ -41,10 +38,28 @@ update_changelog() {
   line_num=$(( line_num + 2 ))
 
   git-chglog --next-tag "v$next_ver" | \
-    sedi "$line_num r /dev/stdin" "$SCRIPT_DIR/../CHANGELOG.md"
+    sedi "$line_num r /dev/stdin" "$changelog"
+
+  echo "Updated file: $changelog"
+}
+
+ensure_semver() {
+  if [[ ! -f $semver ]]; then
+    echo "To download semver-tool"
+    curl -Lo "$semver" https://raw.githubusercontent.com/fsaintjacques/semver-tool/master/src/semver
+    chmod +x "$semver"
+  fi
 }
 
 main() {
+  if [[ ! -f "$changelog" ]]; then
+    git-chglog > "$changelog"
+    echo "Created file: $changelog"
+    return 0
+  fi
+
+  ensure_semver
+
   local version_file="$SCRIPT_DIR/../version"
   local cur_ver next_ver
   cur_ver=$(cat "$version_file")