# 项目规范

**Repository Path**: gdcp-dx/project-specification

## Basic Information

- **Project Name**: 项目规范
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-18
- **Last Updated**: 2022-03-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 电协项目规范参考

## 介绍

如题

## 目录结构

使用`tree`命令生成

windows下使用`tree /F`

linux也有（且更好用）但不默认安装


```
./
│  LICENSE
│  README.en.md
│  README.md
│
├─.gitee
│      ISSUE_TEMPLATE.zh-CN.md
│      PULL_REQUEST_TEMPLATE.zh-CN.md
│
└─specification
        Markdown编写规范.md
        RFC2119中文版.md
        文件格式说明.md
        项目要求.md
```

## 项目规范

使用git做版本控制

### add commit，push一把梭（基础操作）

git教程：https://www.runoob.com/git

视频(看看就好( ͡°ᴥ ͡° ʋ))：[Git & Github 超简单入门教学 10分钟学会使用github！](https://www.bilibili.com/video/BV1c4411X7oR)

相关文章推荐

- 1、[Git 简明指南](https://www.runoob.com/manual/git-guide/)
- 2、[Git 五分钟教程](https://www.runoob.com/w3cnote/git-five-minutes-tutorial.html)
- 3、[Git GUI使用方法](https://www.runoob.com/w3cnote/git-gui-window.html)
- 4、[Github 简明教程](https://www.runoob.com/w3cnote/git-guide.html)
- 5、[互联网组织的未来：剖析GitHub员工的任性之源](https://www.runoob.com/w3cnote/internet-organization-github.html)


### 学习git推荐（适合用来学习git）：

玩游戏学git：https://learngitbranching.js.org/?locale=zh_CN

git官方书籍：https://git-scm.com/book/zh/v2


详细项目规范：[specification](./specification)

### 文档规范

文档使用Markdown

Markdown教程：https://www.runoob.com/markdown

详细Markdown规范：[Markdown编写规范](./specification/Markdown编写规范)

#### 标题规范

错误写法
```markdown
# 标题
xxxxxxx

#### 二级标题1
xxxxxxxx

##### 三级标题1-1
xxx
##### 三级标题1-2
xxx

#### 二级标题2
xxx
```

正确写法，`#`层层递进

```markdown
# 标题
xxxxxxx

## 二级标题1
xxxxxxxx

### 三级标题1-1
xxx
### 三级标题1-2
xxx

## 二级标题2
xxx
```

#### 图片

Markdown文档的图片应放在名为`文件名+.assets`的目录下，例如：

文件名：README.md

对应放图片的目录名：README.assets