phper-linux-gitbook/CONTRIBUTING.md

贡献指南

非常感谢您关注 PHPer 必知必会的 Linux 命令项目，在提交您的贡献之前，请务必认真阅读以下准则。

• 问题反馈
• 开发指南
  • 常用脚本命令（npm scripts）
  • 项目结构
  • 提交请求（pull request）
• 文档说明

问题反馈

• 请避免提交重复的 Issue，在提交之前搜索现有的 Issue 。
• 请确定 Issue 的类型，并在 Issue 内容描述清晰，我们将根据内容对 Issue 打上对应的 label 。

开发设置

项目依赖 GitBook ，需要安装 Node.js 版本8+ ，下载项目到本地后安装依赖 gitbook install 。

常用脚本命令

# 启动本地 HTTP 服务器用来本地预览
$ gitbook serve

# 编译 markdown 文档为 html 文件
$ gitbook build

项目结构

phper-linux-gitbook      
├── images              # 文档图片
├── node_modules        # 第三方依赖库
├── styles              # 样式文件
├── README.md           # 文档首页
├── .gitattributes      # git 配置文件，可以设计导出时忽略文件等
├── .gitignore          # git 忽略文件配置列表
├── book.json           # gitbook 配置
└── ...                 # 内容文件

提交请求（pull request）

1. fork Nick233333/phper-linux-gitbook
2. 把个人仓库（repository）克隆到电脑上，并安装所依赖的插件。
3. 开始编辑文件，可以通过命令 gitbook serve 预览编辑的效果。
4. 推送（push）分支。
5. 建立一个新的合并申请（pull request）并描述变动。

文档说明

• 文档基于 Markdown 格式编写。
• 使用中文半角标点符号。
• 名词区分大小写。
• 英文、代码、链接前后添加空格。
• 新增文档需要添加文档对应的目录配置