贡献者,你好! 感谢您对本项目做出的支持!以下是一些注意事项。 ## 在哪里贡献? 您可以通过提Issues,或者发起PR (Pull Request) 的方式来贡献。在贡献时,我们建议您将负责人设置为LinuxCabin的一位管理成员以更快处理您的请求。 下面是一个可供参考的模板: ``` 我希望增加内容的标题: The Title 这个内容应被放置/追加在:Chapter-Another Chapter章节 章节内容: xxxxxx ``` 若您的内容被退回,建议您仔细阅读退回原因。如果经过修改没有问题,我们允许您再次提交。 ### 我们不建议您贡献的内容 - 与Linux无关的内容 - 专业性过高的内容 - 偏颇/太过不常见的内容(如果值得商讨您也可以贡献) - 由AIGC生成的内容(经由人工审定除外) ## PR贡献的工作流? 请确保您的电脑已经安装了最新版的Python,并被添加到PATH中。 在clone仓库后,请您执行来安装必要的库: ``` pip install -r requirements.txt ``` 我们的文章全部位于/docs目录下。如果您添加了之前不存在的章节,请您修改`mkdocs.yml`下的`nav`(照葫芦画瓢就行)来使得您的内容显示在侧边栏导航。 如果您要预览内容,我们建议您执行以下指令来查看网页显示效果: ``` mkdocs serve ``` ## 贡献时要符合什么规定? ### 总体 1. 所有内容**必须符合中华人民共和国法律**,不得出现涉政、色情、赌毒等内容。 2. 部分内容需按照templates下的**模板**进行填写,允许在下方追加内容。 3. 媒体资源建议引用**中国大陆用户能够正常访问**的资源。 4. 我们建议引用链接为**简体中文官方内容**。 5. 我们建议所有内容用尽可能简单的语言进行阐释。 ### 发行版 1. 请不要将多个发行版合并到一篇文章中。 2. 衍生发行版不应被置于父发行版的“风味”部分,而应单开一页。 3. **请确保镜像源以及换源教程地址存在。** 再次感谢您的理解!