Skip to content

Commit 31d225a

Browse files
committed
site: add readme introducing conventional commits
1 parent af9a303 commit 31d225a

File tree

1 file changed

+76
-0
lines changed

1 file changed

+76
-0
lines changed

README.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Minortex's Blog
2+
3+
This repository contains the source for Minortex's personal blog, built with [Hugo](https://gohugo.io/).
4+
5+
## Commit Guidelines
6+
7+
To maintain a clean and readable git history, please follow these simplified commit conventions. All commit messages must be in English.
8+
9+
### 1. New Article
10+
11+
When adding a new article, use the `new` type.
12+
13+
**Format:**
14+
`new: add new article about <topic>`
15+
16+
**Example:**
17+
`new: add new article about linux swap`
18+
19+
### 2. Modifying an Article
20+
21+
When modifying an existing article, use `docs` for content updates or `fix` for correcting mistakes (e.g., typos).
22+
23+
**The commit scope `()` is required and must contain the article's folder name.** The folder name is the one found under `content/posts/`.
24+
25+
**Format:**
26+
`<type>(<article-folder-name>): <description of change>`
27+
28+
**Examples:**
29+
30+
- To update the content of the article in the `about_swap_on_linux` folder:
31+
`docs(about_swap_on_linux): clarify the section on zswap`
32+
33+
- To fix a typo in the article in the `credit_card` folder:
34+
`fix(credit_card): correct typo in the introduction`
35+
36+
### 3. Blog Features and Infrastructure
37+
38+
When adding new features or making changes to the blog's infrastructure (configuration, theme, build system, etc.), use the `site` type.
39+
40+
**Format:**
41+
`site: <description of feature or infrastructure change>`
42+
43+
**Examples:**
44+
45+
- Add new functionality:
46+
`site: add RSS feed support`
47+
48+
- Update theme or styling:
49+
`site: update color scheme in theme config`
50+
51+
- Upgrade dependencies:
52+
`site: upgrade Hugo to version 0.120.0`
53+
54+
- Improve blog siteures:
55+
`site: enable minification for CSS and JS`
56+
57+
### 4. Chores
58+
59+
Maintenance tasks that don't modify the blog content or functionality, such as updating dependencies, renaming directories, or other housekeeping activities.
60+
61+
**Format:**
62+
`chore: <description of maintenance task>`
63+
64+
**Examples:**
65+
66+
- Rename directories:
67+
`chore: rename the post directory`
68+
69+
- Update theme submodule:
70+
`chore: update blowfish theme to latest version`
71+
72+
- Clean up repository:
73+
`chore: remove unused assets`
74+
75+
- Update gitignore:
76+
`chore: add build artifacts to .gitignore`

0 commit comments

Comments
 (0)