Skip to content

Commit 51b0f72

Browse files
author
shijiashuai
committed
docs: update README and add project infrastructure files
1 parent c4162cb commit 51b0f72

File tree

5 files changed

+84
-0
lines changed

5 files changed

+84
-0
lines changed

‎.editorconfig‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
insert_final_newline = true
7+
trim_trailing_whitespace = true
8+
indent_style = space
9+
indent_size = 2
10+
11+
[*.{ts,tsx,js,jsx,json,css,html}]
12+
indent_size = 2
13+
14+
[*.md]
15+
trim_trailing_whitespace = false

‎CONTRIBUTING.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing
2+
3+
感谢你对本项目的关注！欢迎通过 Issue 和 Pull Request 参与贡献。
4+
5+
## 开发流程
6+
7+
1. Fork 本仓库
8+
2. 创建特性分支：`git checkout -b feature/your-feature`
9+
3. 提交更改：`git commit -m "feat: add your feature"`
10+
4. 推送分支：`git push origin feature/your-feature`
11+
5. 创建 Pull Request
12+
13+
## 开发与测试
14+
15+
```bash
16+
npm install
17+
npm run dev # 启动开发服务器
18+
npm run build # 构建项目
19+
```
20+
21+
## 代码规范
22+
23+
- TypeScript/React 代码遵循 ESLint 配置
24+
- 使用 `.editorconfig` 中定义的缩进和格式规则
25+
- 组件设计遵循 React 最佳实践
26+
- 确保构建无错误
27+
28+
## 提交信息格式
29+
30+
推荐使用 [Conventional Commits](https://www.conventionalcommits.org/)：
31+
32+
- `feat:` 新功能
33+
- `fix:` 修复 Bug
34+
- `docs:` 文档更新
35+
- `style:` UI/样式调整
36+
- `refactor:` 重构

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 LessUp
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Digital Human Platform
22

3+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
4+
![React](https://img.shields.io/badge/React-18-61DAFB?logo=react&logoColor=black)
5+
![TypeScript](https://img.shields.io/badge/TypeScript-5-3178C6?logo=typescript&logoColor=white)
6+
![Three.js](https://img.shields.io/badge/Three.js-r150+-000000?logo=threedotjs&logoColor=white)
7+
![Vite](https://img.shields.io/badge/Vite-5-646CFF?logo=vite&logoColor=white)
8+
39
基于Web技术的3D数字人交互平台
410

511
## 🚀 项目介绍

‎changelog/2025-02-13_project-infrastructure.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# 2025-02-13 项目基础设施优化
2+
3+
## 新增
4+
- 添加 MIT LICENSE 文件
5+
- 添加 `.editorconfig`（统一代码格式）
6+
- README 添加标准化 badges（License、React、TypeScript、Three.js、Vite）

0 commit comments

Comments
 (0)