From 0d3eac029cb680a4315ebf379cac3353854e7b25 Mon Sep 17 00:00:00 2001 From: JimhHan <50871214+JimhHan@users.noreply.github.com> Date: Fri, 26 Mar 2021 11:42:06 +0800 Subject: [PATCH] Add: contributing guidelines --- .github/CONTRIBUTING.md | 47 +++++++++++++++++++++++++++++++++++++++ docs/document/document.md | 34 ++++++++++++++++++++-------- 2 files changed, 72 insertions(+), 9 deletions(-) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..e3a72ed --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,47 @@ +# 为 Project X 的文档贡献 + +欢迎您为 Project X 的文档做出贡献，我们感谢每一位 Contributor 的贡献！是你们让 Xray 更加强大！ + +## 改进文档 + +Project X 的文档托管在 [GitHub](https://github.com/XTLS/Xray-docs-next) 上. + +您可以通过以下步骤, 提交您对文档的改动: + +1. 从 [project X 文档仓库](https://github.com/XTLS/Xray-docs-next) 打开仓库, 点击右上角的 fork, fork 一份文档仓库的镜像到您自己的 github 仓库. + +2. 使用任何您喜欢的工具, 从您克隆的仓库获得文档的克隆, 如: + +``` +git clone https://github.com/XTLS/Xray-docs-next.git +``` + +3. 基于 main 分支创建新的分支, 如: + +``` +git checkout -b your-branch +``` + +4. 在新分支上做修改。 + + 注：在修改时请注意遵循 [中文文案排版指北](https://github.com/sparanoid/chinese-copywriting-guidelines) + +5. 修改完成后，请格式化您的更改。建议使用 Prettier + + 注：存在格式问题或不遵循中文文案排版指北的 PR，将有可能被拒绝。 + +6. 提交修改，并推送到您的仓库中 + +``` +git push -u origin your-branch +``` + +6. 打开 GitHub, 点击 'Pull request' 向 [project X 文档仓库](https://github.com/XTLS/Xray-docs-next) 提交 PR。 + +7. 请在 PR 的标题和正文中，概述此次 PR 新增/修改的内容等； + +8. 等待回应, 如果 PR 被 merge, 您做的修改将直接呈现在 [Project X 文档网站](https://xtls.github.io)。 + +## 发现问题？ + +如果您发现文档出错，可以改进文档或提交一个 Issue。 diff --git a/docs/document/document.md b/docs/document/document.md index c375691..e3a72ed 100644 --- a/docs/document/document.md +++ b/docs/document/document.md @@ -1,31 +1,47 @@ -# 改进文档 +# 为 Project X 的文档贡献 -Project X 的文档托管在 [GitHub](https://github.com/XTLS/XTLS.github.io) 上. +欢迎您为 Project X 的文档做出贡献，我们感谢每一位 Contributor 的贡献！是你们让 Xray 更加强大！ + +## 改进文档 + +Project X 的文档托管在 [GitHub](https://github.com/XTLS/Xray-docs-next) 上. 您可以通过以下步骤, 提交您对文档的改动: -1. 从 [project X 文档仓库](https://github.com/XTLS/XTLS.github.io) 打开仓库, 点击右上角的 fork, fork 一份文档仓库的镜像到您自己的 github 仓库. - +1. 从 [project X 文档仓库](https://github.com/XTLS/Xray-docs-next) 打开仓库, 点击右上角的 fork, fork 一份文档仓库的镜像到您自己的 github 仓库. 2. 使用任何您喜欢的工具, 从您克隆的仓库获得文档的克隆, 如: + ``` -git clone https://github.com/yours/XTLS.github.io +git clone https://github.com/XTLS/Xray-docs-next.git ``` 3. 基于 main 分支创建新的分支, 如: + ``` git checkout -b your-branch ``` -4. 在新分支上做修改, 完成后提交修改 +4. 在新分支上做修改。 + + 注：在修改时请注意遵循 [中文文案排版指北](https://github.com/sparanoid/chinese-copywriting-guidelines) + +5. 修改完成后，请格式化您的更改。建议使用 Prettier + + 注：存在格式问题或不遵循中文文案排版指北的 PR，将有可能被拒绝。 + +6. 提交修改，并推送到您的仓库中 -5. 推送创建的分支到您的仓库 ``` git push -u origin your-branch ``` -6. 打开 github, 点击 'Pull request' 向 [project X 文档仓库](https://github.com/XTLS/XTLS.github.io)发出PR. +6. 打开 GitHub, 点击 'Pull request' 向 [project X 文档仓库](https://github.com/XTLS/Xray-docs-next) 提交 PR。 7. 请在 PR 的标题和正文中，概述此次 PR 新增/修改的内容等； -8. 等待回应, 如果 PR 被 merge, 您做的修改将直接呈现在 [Project X 文档网站](https://xtls.github.io)。 \ No newline at end of file +8. 等待回应, 如果 PR 被 merge, 您做的修改将直接呈现在 [Project X 文档网站](https://xtls.github.io)。 + +## 发现问题？ + +如果您发现文档出错，可以改进文档或提交一个 Issue。