本地预览需先安装 docker-compose,否则命令无法执行;新增翻译需同时在 config.yaml 中登记语言,否则不会显示;改动应提交到 content/next 目录而非已发布版本目录
conventionalcommits.org
conventional-commitsMIT更新放缓一套给 Git 提交信息定格式的约定规范,让提交记录可读、可自动解析,方便生成变更日志和推导版本号。
The conventional commits specification
docker-compose upREADME 未说明;本地预览依赖 docker-compose,无 GPU 或显存要求
Conventional Commits 规范官网仓库,用 HUGO 维护多语言规范文档
一套给 Git 提交信息定格式的约定规范,让提交记录可读、可自动解析,方便生成变更日志和推导版本号。
核心能力
- 用 HUGO 静态站点生成器组织规范内容
- content/next 目录集中存放待修改的规范版本
- 按 index.[lang].md 命名维护多语言翻译
- 提供 docker-compose 一键本地预览站点
- 提供 README 徽章供项目声明遵循该规范
容易踩的坑
暂无 release 数据(可能没有发版,或尚未同步)。
用户点评
登录用户的真实使用记录,可按版本和硬件筛选还没有人点评。第一个说出真实体验的人最有价值。
ConventionalCommits.org
This repo is the home of the Conventional Commits specification.
Repo Layout
We use HUGO as static site generator, so we use the directory structure HUGO proposes.
Our implementation
./content: contains all the versions of the specification../content/next/: contains the version of the specification (where all the changes SHOULD be made)../content/**/index.[lang].md: contains the content of the specification, if a language is specified it's a translation.
Contributing
We'd love your help refining the language of this specification, fixing typos, or adding more translations. Please don't hesitate to send a pull request.
Adding a translation
- Create a new file in
./content/version/index.[lang].mdusing the hugo commandhugo new [version]/index.[lang].md. - Ensure all files have the appropriate fields required (see others as an example)..
- Add the language to the
config.yamlfile (see others as an example).
Running project locally
There's a docker-compose.yml file ready that will help you to check if the website looks good!
To run it make sure you have docker-compose installed on your machine and just use the command docker-compose up to make it run locally.
Once the website will be compiled, you can see the website visiting http://localhost:1313
Badges!
Tell your users that you use the Conventional Commits specification:
[](https://conventionalcommits.org)
Thank you
To Lorenzo D'Ianni for the great effort creating the CSS and the HTML for the new UI.
To Netlify to host our project, giving us a lot of amazing built in functionality for free.
To semver.org: we used semver.org as a blueprint for the structure of this specification and the first version of the website.