CONTRIBUTING.md

贡献指南

非常感谢您关注 Nginx 入门教程项目，在提交您的贡献之前，请务必认真阅读以下准则。

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

问题反馈

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

开发设置

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

常用脚本命令

# 启动本地 HTTP 服务器用来本地预览
$ yarn dev

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

项目结构

docs                - 文档目录
├── .vuepress       - 文档配置
├── README.md       - 文档首页
├── config          - 配置文档目录
├── example         - 示例文档目录
├── guide           - 入门文档目录
└── variable        - 变量文档目录

提交请求（pull request）

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

文档说明

• 文档基于 Markdown 格式编写。
• 文档编辑地址可通过访问文档左下角编辑按钮获得。
• 文档内链接使用绝对路径，如： [新的起点](/guide/dir.html) 。
• 使用中文半角标点符号。
• 名词区分大小写。
• 英文、代码、链接前后添加空格。
• 新增文档需要添加文档对应的目录配置（docs/.vuepress/config.js）。