2022-02-03 17:24:51 +08:00
|
|
|
|
<!-- Copyright (c) 2016-2022 Wang Shidong & Contributors -->
|
2022-03-27 13:38:54 +08:00
|
|
|
|
<!-- Author: Wang Shidong < wsdjeg@outlook.com > -->
|
2020-09-14 20:20:46 +08:00
|
|
|
|
<!-- URL: https://spacevim.org -->
|
|
|
|
|
|
<!-- License: GPLv3 -->
|
|
|
|
|
|
|
|
|
|
|
|
## 贡献代码
|
|
|
|
|
|
|
|
|
|
|
|
SpaceVim 这一项目的存在，得益于所有参与贡献的朋友，我们非常感谢来自于社区的贡献。
|
|
|
|
|
|
为了能够更好的维护 SpaceVim，我们制定了如下规则，要求所有参与的开发者共同遵守。
|
|
|
|
|
|
|
|
|
|
|
|
### 贡献代码
|
|
|
|
|
|
|
|
|
|
|
|
我们非常欢迎开发者贡献代码，请仔细阅读以下内容。同时也可以加入我们的[中文聊天室](https://gitter.im/SpaceVim/cn)，
|
|
|
|
|
|
沟通交流。
|
|
|
|
|
|
|
|
|
|
|
|
|
2022-04-14 22:21:08 +08:00
|
|
|
|
#### 开源协议
|
2020-09-14 20:20:46 +08:00
|
|
|
|
|
2022-04-14 22:21:08 +08:00
|
|
|
|
SpaceVim 的所有部分均遵循 GPLv3 协议. 这包括:
|
2020-09-14 20:20:46 +08:00
|
|
|
|
|
2022-04-14 22:21:08 +08:00
|
|
|
|
- 初始化和核心文件.
|
|
|
|
|
|
- 所有 layer 文件.
|
|
|
|
|
|
- 文档.
|
2020-09-14 20:20:46 +08:00
|
|
|
|
|
2022-04-14 22:21:08 +08:00
|
|
|
|
对于不属于 SpaceVim 的文件, 例如本地包和库, 请参考头文件.
|
|
|
|
|
|
这些文件的头部不应为空, 若没有一个合适的头文件, 我们可能不会接受代码.
|
2020-09-14 20:20:46 +08:00
|
|
|
|
|
2022-04-14 22:21:08 +08:00
|
|
|
|
#### 约定
|
2020-09-14 20:20:46 +08:00
|
|
|
|
|
2022-04-14 22:21:08 +08:00
|
|
|
|
SpaceVim 基于约定, 主要用于函数命名, 按键绑定定义和书写文档..
|
|
|
|
|
|
请在第一次贡献前阅读 [约定](https://spacevim.org/cn/conventions/) 来了解它们.
|
2020-09-14 20:20:46 +08:00
|
|
|
|
|
2022-04-14 22:21:08 +08:00
|
|
|
|
#### 拉取请求
|
2020-09-14 20:20:46 +08:00
|
|
|
|
|
2022-04-14 22:21:08 +08:00
|
|
|
|
提交你的贡献到 `master` 分支. 你不应该使用自己的 `master` 分支来修改 SpaceVim,
|
|
|
|
|
|
这个分支是默认只读的.
|
2020-09-14 20:20:46 +08:00
|
|
|
|
|
2022-04-14 22:21:08 +08:00
|
|
|
|
你可能需要阅读我们的 [开发者文档](https://spacevim.org/cn/development/).
|
