mirror of
https://github.com/SpaceVim/SpaceVim.git
synced 2025-02-02 23:20:04 +08:00
docs(dev): update development page
This commit is contained in:
parent
9a55c1266c
commit
9ff8cd53f1
@ -11,13 +11,13 @@ lang: zh
|
|||||||
- [寻求帮助](#寻求帮助)
|
- [寻求帮助](#寻求帮助)
|
||||||
- [反馈问题](#反馈问题)
|
- [反馈问题](#反馈问题)
|
||||||
- [贡献代码](#贡献代码)
|
- [贡献代码](#贡献代码)
|
||||||
- [项目代码结构](#项目代码结构)
|
- [代码结构](#代码结构)
|
||||||
- [证书](#证书)
|
- [许可](#许可)
|
||||||
- [公约](#公约)
|
- [公约](#公约)
|
||||||
- [合并请求](#合并请求)
|
- [合并请求](#合并请求)
|
||||||
- [操作步骤](#操作步骤)
|
- [操作步骤](#操作步骤)
|
||||||
- [抽象化的简单 PRs(绝大多数 PRs 都是这样的):](#抽象化的简单-prs绝大多数-prs-都是这样的)
|
- [简单合并请求](#简单合并请求)
|
||||||
- [复杂的 PRs (大的重构,等):](#复杂的-prs-大的重构等)
|
- [复杂合并请求](#复杂合并请求)
|
||||||
- [贡献一个模块](#贡献一个模块)
|
- [贡献一个模块](#贡献一个模块)
|
||||||
- [文件头](#文件头)
|
- [文件头](#文件头)
|
||||||
- [新 layer 的作者](#新-layer-的作者)
|
- [新 layer 的作者](#新-layer-的作者)
|
||||||
@ -59,12 +59,10 @@ SpaceVim 是每个志愿者的努力的结晶,我们鼓励你参与进来,Sp
|
|||||||
|
|
||||||
我们非常期待您的贡献。在此之前,请您认真阅读下面的内容。
|
我们非常期待您的贡献。在此之前,请您认真阅读下面的内容。
|
||||||
|
|
||||||
### 项目代码结构
|
### 代码结构
|
||||||
|
|
||||||
|
|
||||||
```txt
|
```txt
|
||||||
├─ .ci/ 自动构建脚本
|
|
||||||
├─ .github/ issue/PR templates
|
|
||||||
├─ .SpaceVim.d/ 开发者配置
|
├─ .SpaceVim.d/ 开发者配置
|
||||||
├─ autoload/SpaceVim.vim 核心逻辑文件
|
├─ autoload/SpaceVim.vim 核心逻辑文件
|
||||||
├─ autoload/SpaceVim/api/ 公共函数(API)
|
├─ autoload/SpaceVim/api/ 公共函数(API)
|
||||||
@ -73,12 +71,11 @@ SpaceVim 是每个志愿者的努力的结晶,我们鼓励你参与进来,Sp
|
|||||||
├─ autoload/SpaceVim/mapping/ 快捷键
|
├─ autoload/SpaceVim/mapping/ 快捷键
|
||||||
├─ doc/ 帮助文档
|
├─ doc/ 帮助文档
|
||||||
├─ docs/ 网站源码
|
├─ docs/ 网站源码
|
||||||
├─ wiki/ 维基源码
|
|
||||||
├─ bin/ 可执行命令
|
├─ bin/ 可执行命令
|
||||||
└─ test/ 测试文件
|
└─ test/ 测试文件
|
||||||
```
|
```
|
||||||
|
|
||||||
### 证书
|
### 许可
|
||||||
|
|
||||||
SpaceVim 所有部分采用 GPLv3 许可。
|
SpaceVim 所有部分采用 GPLv3 许可。
|
||||||
|
|
||||||
@ -157,7 +154,7 @@ SpaceVim 所有部分采用 GPLv3 许可。
|
|||||||
。。。。
|
。。。。
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 抽象化的简单 PRs(绝大多数 PRs 都是这样的):
|
#### 简单合并请求
|
||||||
|
|
||||||
- `master`中的分支
|
- `master`中的分支
|
||||||
- 每个 PR 一个主题
|
- 每个 PR 一个主题
|
||||||
@ -165,7 +162,7 @@ SpaceVim 所有部分采用 GPLv3 许可。
|
|||||||
- 如果你有一些不同主题的提交,请关闭 PR 然后为每个主题创建一个新的 PR
|
- 如果你有一些不同主题的提交,请关闭 PR 然后为每个主题创建一个新的 PR
|
||||||
- 如果你仍然有很多提交,请把它们打包成一个提交
|
- 如果你仍然有很多提交,请把它们打包成一个提交
|
||||||
|
|
||||||
#### 复杂的 PRs (大的重构,等):
|
#### 复杂合并请求
|
||||||
|
|
||||||
只打包一些枯燥的提交,比如修改错别字,语法修复,等等。把重要和独立的步骤分别放在不同的提交中。
|
只打包一些枯燥的提交,比如修改错别字,语法修复,等等。把重要和独立的步骤分别放在不同的提交中。
|
||||||
这些 PRs 被合并并且明示非快速转发。
|
这些 PRs 被合并并且明示非快速转发。
|
||||||
|
Loading…
Reference in New Issue
Block a user