# s_dev_guidelines

**Repository Path**: smallerxuan/s_dev_guidelines

## Basic Information

- **Project Name**: s_dev_guidelines
- **Description**: 一套可直接落地的中文软件开发规范，覆盖代码编写、提交信息、分支管理三个核心环节。适用于各类软件项目：通用库、应用程序、服务、嵌入式固件等。
- **Primary Language**: Unknown
- **License**: CC-BY-4.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-27
- **Last Updated**: 2026-07-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Dev Guidelines — 软件开发规范集

[![License: CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg)](LICENSE)

一套可直接落地的中文软件开发规范，覆盖**代码编写**、**提交信息**、**分支管理**三个核心环节。适用于各类软件项目：通用库、应用程序、服务、嵌入式固件等。

## 收录文档

| 文档 | 内容概要 | 规范基准 |
|------|---------|---------|
| [C 语言代码编写规范](C语言代码编写规范.md) | 命名、格式化、数据类型、函数设计、指针内存、宏、注释、错误处理、头文件管理、编译警告等 13 章 | Linux Kernel Style + GNU Coding Standards |
| [Git 提交信息规范](Git%20提交信息规范.md) | Conventional Commits 结构化指南：type/scope/subject/body/footer 详解、正误示例、SemVer 映射、commitlint 配置 | [Conventional Commits v1.0.0](https://www.conventionalcommits.org/) |
| [Git 分支管理规范](Git%20分支管理规范.md) | 精简版 Git Flow：分支模型选型、各分支职责、合并策略、分支保护、LTS/多变体策略、小型项目简化模型 | Git Flow / GitHub Flow |

## 文档特点

- **结构化**：每份文档都有对照表格、速查卡和检查清单（Checklist），可直接用于 Code Review
- **带正误示例**：关键规则均有 ❌ 错误 / ✅ 正确对照代码
- **工具链集成**：附 commitlint、husky、clang-format、git-cliff 等自动化配置示例
- **通用版设计**：不绑定特定项目，各项目可在其基础上增补私有约定（如 scope 列表）
- **有取舍说明**：不只给规则，也说明"为什么"以及何时可以简化（如单人项目模型）

## 如何使用

1. **直接采纳**：将文档复制到项目 `doc/` 目录，在贡献指南（CONTRIBUTING）中引用
2. **按需裁剪**：以通用版为基线，增补项目特定约定（推荐方式，各文档末尾已预留说明）
3. **团队落地建议**：
   - 代码规范 → 配置 `.clang-format` 统一格式化，CI 中加编译警告检查
   - 提交规范 → 配置 commitlint + Git 钩子，在 CI 中校验
   - 分支规范 → 在 GitHub/GitLab 配置分支保护规则（文档第五章有配置表）

## Roadmap

计划陆续补充：

- [ ] Code Review 规范
- [ ] 语义化版本（SemVer）与发布流程规范
- [ ] 技术文档编写规范（README / API 文档）
- [ ] 单元测试规范
- [ ] 英文版（English translation）

欢迎通过 Issue 提出希望补充的规范主题。

## License

本规范集基于 [Creative Commons Attribution 4.0 International (CC BY 4.0)](LICENSE) 发布。

你可以自由地共享、修改、用于商业用途，只需**署名原作者**（附上本项目链接即可）。