From 22e76fb70c4c2fd40ad03bd970209ebcb4f9c748 Mon Sep 17 00:00:00 2001 From: latercomer Date: Sat, 28 Sep 2024 10:04:13 +0800 Subject: [PATCH] =?UTF-8?q?=E8=B0=83=E6=95=B4docs=E5=AF=BC=E8=88=AA?= =?UTF-8?q?=E6=A0=8F=E9=A1=BA=E5=BA=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: latercomer --- docs/SUMMARY.md | 4 +- docs/community/SUMMARY.md | 4 ++ docs/community/code-of-conduct.md | 109 ++++++++++++++---------------- docs/community/contribute.md | 2 +- 4 files changed, 59 insertions(+), 60 deletions(-) create mode 100644 docs/community/SUMMARY.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 0833f41900..1b6d792cb3 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -1,8 +1,8 @@ * [首页](index.md) * [关于我们](about/) -* [用户手册](manual/) -* [开发指南](develop/) * [商业定制](solution/) * [精彩探索](discovery/) +* [用户手册](manual/) +* [开发指南](develop/) * [社区支持](community/) * [淘宝店铺](https://nextpilot.taobao.com) diff --git a/docs/community/SUMMARY.md b/docs/community/SUMMARY.md new file mode 100644 index 0000000000..402bb14e92 --- /dev/null +++ b/docs/community/SUMMARY.md @@ -0,0 +1,4 @@ +* [技术支持](./support.md) +* [贡献代码](./contribute.md) +* [开源许可](./license.md) +* [行为准测](./code-of-conduct.md) diff --git a/docs/community/code-of-conduct.md b/docs/community/code-of-conduct.md index 6b37cec085..fc62ddcf68 100644 --- a/docs/community/code-of-conduct.md +++ b/docs/community/code-of-conduct.md @@ -4,99 +4,96 @@ We pledge to adhere to the [nextpilot code of conduct](https://github.com/nextpi === "简体中文" -``` -# 贡献者公约 + # 贡献者公约 -## 我们的承诺 + ## 我们的承诺 -身为项目成员、贡献者、负责人，我们保证参与此社区的每个人都不受骚扰，不论其年龄、体型、身体条件、民族、性征、性别认同与表现、经验水平、教育程度、社会地位、国籍、相貌、种族、宗教信仰及性取向如何。 + 身为项目成员、贡献者、负责人，我们保证参与此社区的每个人都不受骚扰，不论其年龄、体型、身体条件、民族、性征、性别认同与表现、经验水平、教育程度、社会地位、国籍、相貌、种族、宗教信仰及性取向如何。 -我们承诺致力于建设开放、友善、多元、包容、健康的社区环境。 + 我们承诺致力于建设开放、友善、多元、包容、健康的社区环境。 -## 我们的准则 + ## 我们的准则 -有助于促进本社区积极环境的行为包括但不限于： + 有助于促进本社区积极环境的行为包括但不限于： -* 与人为善、推己及人 -* 尊重不同的主张、观点和经历 -* 积极提出、耐心接受有益批评 -* 面对过失，承担责任、认真道歉、从中学习 -* 关注社区共同诉求，而非一己私利 + * 与人为善、推己及人 + * 尊重不同的主张、观点和经历 + * 积极提出、耐心接受有益批评 + * 面对过失，承担责任、认真道歉、从中学习 + * 关注社区共同诉求，而非一己私利 -不当行为包括但不限于： + 不当行为包括但不限于： -* 发布与性有关的言论或图像，以及任何形式的献殷勤或勾引 -* 挑衅行为、侮辱或贬损的言论、人身及政治攻击 -* 公开或私下骚扰 -* 未获明确授权擅自发布他人的资料，如地址、电子邮箱等 -* 其他有理由认定为违反职业操守的不当行为 + * 发布与性有关的言论或图像，以及任何形式的献殷勤或勾引 + * 挑衅行为、侮辱或贬损的言论、人身及政治攻击 + * 公开或私下骚扰 + * 未获明确授权擅自发布他人的资料，如地址、电子邮箱等 + * 其他有理由认定为违反职业操守的不当行为 -## 落实之义务 + ## 落实之义务 -社区负责人有责任诠释何谓“妥当行为”，并据此准则，妥善公正地认定与处置不当、威胁、冒犯及有害的行为。 + 社区负责人有责任诠释何谓“妥当行为”，并据此准则，妥善公正地认定与处置不当、威胁、冒犯及有害的行为。 -社区负责人有权利和义务删除、编辑、拒绝违背本公约的评论（comment）、提交（commit）、代码、维基（wiki）编辑、问题（issue）等贡献。如有必要，需告知采取措施之理由。 + 社区负责人有权利和义务删除、编辑、拒绝违背本公约的评论（comment）、提交（commit）、代码、维基（wiki）编辑、问题（issue）等贡献。如有必要，需告知采取措施之理由。 -## 适用范围 + ## 适用范围 -此行为标准适用于本社区全部场合，以及在其他场合代表本社区的个人。 + 此行为标准适用于本社区全部场合，以及在其他场合代表本社区的个人。 -代表本社区的情形包括但不限于：使用官方电子邮件与社交平台、作为指定代表参与在线或线下活动。 + 代表本社区的情形包括但不限于：使用官方电子邮件与社交平台、作为指定代表参与在线或线下活动。 -## 贯彻落实 + ## 贯彻落实 -如遇滥用、骚扰等不当行为，请通过 nextpilot@qq.com 向纪律检查委员举报。 -纪委将迅速审议并调查全部投诉。 + 如遇滥用、骚扰等不当行为，请通过 nextpilot@qq.com 向纪律检查委员举报。 + 纪委将迅速审议并调查全部投诉。 -社区全体负责人有义务保密举报者信息。 + 社区全体负责人有义务保密举报者信息。 -## 指导方针 + ## 指导方针 -社区负责人将依据下列方案判断并处置违纪行为： + 社区负责人将依据下列方案判断并处置违纪行为： -### 一、督促 + ### 一、督促 -**社区影响**：用语不当、举止不符合职业道德或不受社区欢迎。 + **社区影响**：用语不当、举止不符合职业道德或不受社区欢迎。 -**处理意见**：由社区负责人予以非公开的书面警告，阐明违纪事由、解释举止如何不妥。或将要求公开道歉。 + **处理意见**：由社区负责人予以非公开的书面警告，阐明违纪事由、解释举止如何不妥。或将要求公开道歉。 -### 二、警告 + ### 二、警告 -**社区影响**：一起或多起事件中的违纪行为。 + **社区影响**：一起或多起事件中的违纪行为。 -**处理意见**：警告继续违纪之后果、违纪者在特定时间内禁止与当事人往来、不得擅自与社区执法者往来，禁令涵盖社区内外、社交网络在内的一切联络。如有违反，可致封禁乃至开除。 + **处理意见**：警告继续违纪之后果、违纪者在特定时间内禁止与当事人往来、不得擅自与社区执法者往来，禁令涵盖社区内外、社交网络在内的一切联络。如有违反，可致封禁乃至开除。 -### 三、封禁 + ### 三、封禁 -**社区影响**：严重违纪行为，包括屡教不改。 + **社区影响**：严重违纪行为，包括屡教不改。 -**处理意见**：违纪者在特定时间内禁止与社区的任何往来或公开联络，禁止任何与当事人公开或私下往来，不得擅自与社区执法者往来。如有违反，可致开除。 + **处理意见**：违纪者在特定时间内禁止与社区的任何往来或公开联络，禁止任何与当事人公开或私下往来，不得擅自与社区执法者往来。如有违反，可致开除。 -### 四、开除 + ### 四、开除 -**社区影响**：典型违纪行为，例如屡教不改、骚扰某个人、敌对或贬低某个群体。 + **社区影响**：典型违纪行为，例如屡教不改、骚扰某个人、敌对或贬低某个群体。 -**处理意见**：无限期禁止违纪者与项目社区的一切公开往来。 + **处理意见**：无限期禁止违纪者与项目社区的一切公开往来。 -## 来源 + ## 来源 -本行为标准改编自[参与者公约][homepage]2.0版，可在此查阅：[https://www.contributor-covenant.org/zh-cn/version/2/0/code_of_conduct.html][v2.0] + 本行为标准改编自[参与者公约][homepage]2.0版，可在此查阅：[https://www.contributor-covenant.org/zh-cn/version/2/0/code_of_conduct.html][v2.0] -指导方针借鉴自[Mozilla纪检分级][Mozilla CoC]。 + 指导方针借鉴自[Mozilla纪检分级][Mozilla CoC]。 -此行为标准常见问题请洽：[https://www.contributor-covenant.org/faq][FAQ]。 -另有诸译本：[https://www.contributor-covenant.org/translations][translations]。 + 此行为标准常见问题请洽：[https://www.contributor-covenant.org/faq][FAQ]。 + 另有诸译本：[https://www.contributor-covenant.org/translations][translations]。 -[homepage]:https://www.contributor-covenant.org -[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html -[Mozilla CoC]: https://github.com/mozilla/diversity -[FAQ]: https://www.contributor-covenant.org/faq -[translations]: https://www.contributor-covenant.org/translations - -``` + [homepage]:https://www.contributor-covenant.org + [v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html + [Mozilla CoC]: https://github.com/mozilla/diversity + [FAQ]: https://www.contributor-covenant.org/faq + [translations]: https://www.contributor-covenant.org/translations === "English" - ``` + # Contributor Covenant Code of Conduct ## Our Pledge @@ -225,5 +222,3 @@ We pledge to adhere to the [nextpilot code of conduct](https://github.com/nextpi For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations. - - ``` diff --git a/docs/community/contribute.md b/docs/community/contribute.md index fffa157f53..2ef5e12d10 100644 --- a/docs/community/contribute.md +++ b/docs/community/contribute.md @@ -104,7 +104,7 @@ VS Code 使用快捷键 `ctr + ,`打开设置页面，搜索`sign off`，然后 ![](./image/vscode-git-sign-off.png) -### 辅助插件 +### Vscode辅助插件 在vscode商店中搜索插件 `git-commit-plugin`，点击安装：