diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 64 |
1 files changed, 9 insertions, 55 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 74c8ce5..d4053a9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,35 +1,6 @@ -贡献者,你好! +# 贡献指南 -感谢您对本项目做出的支持!以下是一些注意事项。 - -## 在哪里贡献? - -您可以通过提Issues,或者发起PR (Pull Request) 的方式来贡献。在贡献时,我们建议您将负责人设置为LinuxCabin的一位管理成员以更快处理您的请求。 - -下面是一个可供参考的模板: - -``` -我希望增加内容的标题: The Title -这个内容应被放置/追加在:Chapter-Another Chapter章节 - -章节内容: - -xxxxxx - -``` - -若您的内容被退回,建议您仔细阅读退回原因。如果经过修改没有问题,我们允许您再次提交。 - -### 我们不建议您贡献的内容 - -- 与Linux无关的内容 -- 专业性过高的内容 -- 偏颇/太过不常见的内容(如果值得商讨您也可以贡献) -- 由AIGC生成的内容(经由人工审核且确认无误的情况除外) - -## PR贡献的工作流? - -### 安装必要依赖 +## 安装必要依赖 请确保您的电脑已经安装了最新版的Python,并被添加到PATH中。 @@ -39,21 +10,22 @@ xxxxxx pip install -r requirements.txt ``` -(注:为防止python3安装的依赖污染系统环境导致系统不稳定,建议[创建venv虚拟环境](#venv虚拟环境)) - ### venv虚拟环境 -#### 如果您直接使用python +为防止Python 3安装的依赖污染系统环境导致系统不稳定,建议您创建venv虚拟环境。 + +#### 直接使用Python + ``` python -m venv .venv -source .venv/bin/active +source .venv/bin/activate pip install -r requirements.txt ``` #### uv ``` uv venv -source .venv/bin/active +source .venv/bin/activate uv pip install -r requirements.txt ``` @@ -69,22 +41,4 @@ uv pip install -r requirements.txt mkdocs serve ``` -> 或者你可以直接在 `pending` 目录下新建一个目录,然后存放你的文档,管理员会将它放到正确的地方(如果审核通过的话) - -## 贡献时要符合什么规定? - -### 总体 - -1. 所有内容**必须符合中华人民共和国法律**,不得出现涉政、色情、赌毒等内容。 -2. 部分内容需按照templates下的**模板**进行填写,允许在下方追加内容。 -3. 媒体资源建议引用**中国大陆用户能够正常访问**的资源。 -4. 我们建议引用链接为**简体中文官方内容**。 -5. 我们建议所有内容用尽可能简单的语言进行阐释。 - -### 发行版 - -1. 请不要将多个发行版合并到一篇文章中。 -2. 衍生发行版不应被置于父发行版的“风味”部分,而应单开一页。 -3. **请确保镜像源以及换源教程地址存在。** - -再次感谢您的理解! +如果您的内容难以分类,你可以在 `pending` 目录下新建一个目录,然后存放你的文档,管理员会将它放到正确的地方。 |
