docs: update README.md

Signed-off-by: qwq233 <qwq233@qwq2333.top>
2022-01-29 21:31:51 +08:00
parent 1e74eddaec
commit 938e94558e
9 changed files with 298 additions and 5 deletions
--- a/.github/CODE_OF_CONDUCT.md
+++ b/.github/CODE_OF_CONDUCT.md
@@ -0,0 +1,90 @@
+
+# 贡献者公约
+
+## 我们的承诺
+
+身为项目成员、贡献者、负责人，我们保证参与此社区的每个人都不受骚扰，不论其年龄、体型、身体条件、民族、性征、性别认同与表现、经验水平、教育程度、社会地位、国籍、相貌、种族、宗教信仰及性取向如何。
+
+我们承诺致力于建设开放、友善、多元、包容、健康的社区环境。
+
+## 我们的准则
+
+有助于促进本社区积极环境的行为包括但不限于：
+
+* 与人为善、推己及人
+* 尊重不同的主张、观点和经历
+* 积极提出、耐心接受有益批评
+* 面对过失，承担责任、认真道歉、从中学习
+* 关注社区共同诉求，而非一己私利
+
+不当行为包括但不限于：
+
+* 发布与性有关的言论或图像，以及任何形式的献殷勤或勾引
+* 挑衅行为、侮辱或贬损的言论、人身及政治攻击
+* 公开或私下骚扰
+* 未获明确授权擅自发布他人的资料，如地址、电子邮箱等
+* 其他有理由认定为违反职业操守的不当行为
+* 恶意评价/诽谤其他xp框架/其他作者
+* 发布涉政敏感话题
+
+## 落实之义务
+
+社区负责人有责任诠释何谓“妥当行为”，并据此准则，妥善公正地认定与处置不当、威胁、冒犯及有害的行为。
+
+社区负责人有权利和义务删除、编辑、拒绝违背本公约的评论（comment）、提交（commit）、代码、维基（wiki）编辑、问题（issue）等贡献。如有必要，需告知采取措施之理由。
+
+## 适用范围
+
+此行为标准适用于本社区全部场合，以及在其他场合代表本社区的个人。
+
+代表本社区的情形包括但不限于：使用官方电子邮件与社交平台、作为指定代表参与在线或线下活动。
+
+## 贯彻落实
+
+如遇滥用、骚扰等不当行为，请通过 [Telegram](https://t.me/gao_cai_sheng_bot) 向纪律检查委员举报。
+纪委将迅速审议并调查全部投诉。
+
+社区全体负责人有义务保密举报者信息。
+
+## 指导方针
+
+社区负责人将依据但不限于下列方案判断并处置违纪行为：
+
+### 一、督促
+
+**社区影响**：用语不当、举止不符合职业道德或不受社区欢迎。
+
+**处理意见**：由社区负责人予以非公开的书面警告，阐明违纪事由、解释举止如何不妥。或将要求公开道歉。
+
+### 二、警告
+
+**社区影响**：一起或多起事件中的违纪行为。
+
+**处理意见**：警告继续违纪之后果、违纪者在特定时间内禁止与当事人往来、不得擅自与社区执法者往来，禁令涵盖社区内外、社交网络在内的一切联络。如有违反，可致封禁乃至开除。
+
+### 三、封禁
+
+**社区影响**：严重违纪行为，包括屡教不改。
+
+**处理意见**：违纪者在特定时间内禁止与社区的任何往来或公开联络，禁止任何与当事人公开或私下往来，不得擅自与社区执法者往来。如有违反，可致永久封禁。
+
+### 四、永久封禁
+
+**社区影响**：典型违纪行为，例如屡教不改、骚扰某个人、敌对或贬低某个群体。
+
+**处理意见**：无限期禁止违纪者与项目社区的一切公开往来。
+
+## 来源
+
+本行为标准改编自[参与者公约][homepage]2.0版，可在此查阅：[https://www.contributor-covenant.org/zh-cn/version/2/0/code_of_conduct.html][v2.0]
+
+指导方针借鉴自[Mozilla纪检分级][Mozilla CoC]。
+
+此行为标准常见问题请洽：[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
--- a/.github/CONTRIBUTION.md
+++ b/.github/CONTRIBUTION.md
@@ -0,0 +1,51 @@
+# 贡献指南
+
+**首先，欢迎您为QAuxiliary这个项目做出贡献。**
+
+## 分支约定
+
+不管是直接 Push 代码还是提交 Pull Request，都必须使 commit 指向 master 分支。
+
+## Commit 相关
+
+1. 禁止中文/拼音
+2. 简洁明了
+3. 一个commit做一件事情
+4. 请勿在commit附上任何有关[skip ci]的字段
+5. 每个commit都必须附着有效的GPG签名
+
+## Pull Request
+
+1. 请勿在修改会被编译分发至用户的部分时在PR标题添加[skip ci]；请务必在文档、模板等不会影响编译流程和实际分发的目标生成，或完全无法编译但出于必要目的必须提交的PR标题添加[skip ci]
+
+## 开发
+
+1. 请确认您的编辑器支持EditorConfig，否则请注意您的编码、行位序列及其其他事项。
+
+2. 在原则上代码风格遵循[Google Java Style](https://google.github.io/styleguide/javaguide.html)[中文翻译](https://github.com/fantasticmao/google-java-style-guide-zh_cn)
+
+3. 每位开发者的代码风格应保持一致
+
+4. 以UTF-8编码，以LF作为行位序列
+
+5. 命名方面应
+    1. 禁止拼音
+
+    2. 使用大写字母分隔单词
+6. 使用4个空格缩进
+
+7. 弃用或注释的代码应删除，若需重复使用请翻阅git log
+
+8. 大括号放应同一行上
+
+9. 代码请务必格式化
+
+10. 将自己的代码放在自己的包里，，另外，应注意的是，如果你创建了自己的包，**一定要记得修改proguard-rules.pro**
+
+11. 除个别情况，必须添加代码头
+
+12. **在任何时候，您都不应该随意更改[build.gradle](build.gradle)，特别是升级 `com.android.tools.build:gradle` 版本**
+
+## 其他
+
+如还有疑问，可直接在Telegram群聊询问
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,40 @@
+---
+name: Bug report
+about: 错误反馈/Bug report / 不使用此模板提交BUG会被close
+title: "[此处填写QQ或TIM版本号] 简要概况问题"
+labels: Bug
+assignees: ''
+
+---
+
+**QQ(TIM)版本/QQ(TIM) Version**
+
+* 
+
+**模块版本/Module Version**
+
+* 
+
+**使用的框架名称与框架版本/Xposed Framework and Framework Version**
+
+* 
+
+**问题的具体描述/Detailed Description of the Bug**
+
+*  具体描述(如复现BUG所需要的前提和必要操作等)
+
+
+
+**此处贴你获取到的日志信息/Log here**
+
+<details><summary>展开查看</summary><pre><code>
+
+（此处贴日志）
+
+</code></pre></details>
+
+
+
+<!--- 勿删此行--->
+
+<!--- ejfweaxptgrsgxed--->
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Group
+    url: https://t.me/QAuxiliaryChat
+    about: Our Telegram Group 
+  - name: smart-question
+    url: http://www.catb.org/~esr/faqs/smart-questions.html
+    about: READ BEFORE YOU ASKING ANY QUESTION
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,31 @@
+---
+name: Feature request
+about: 功能建议/Feature request
+title: "[功能需求] 简要概述需要的功能"
+labels: Feature
+assignees: ''
+
+---
+
+**QQ(TIM)版本/QQ(TIM) Version**
+
+* 
+
+**为什么你认为需要此功能**
+
+* 
+
+**联系到哪些已经存在的bug或者功能**
+
+* 
+
+**具体功能需要/Specific features required**
+
+*  具体描述(如使用的场景，面临的问题)
+
+
+
+<!--- 勿删此行--->
+
+<!--- ejfweaxptgrsgxed--->
+
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,14 @@
+# Tittle Here
+<!--- Provide a general summary of your changes in the title above. -->
+<!--- Anything on lines wrapped in comments like these will not show up in the final text. -->
+
+## Description
+<!--- Describe your changes in detail here. -->
+
+## Issues Fixed or Closed by This PR
+
+## Check List
+
+- [ ] I have tested the changes and verified that they work and don't break anything(as well as I can manage) or drop the support for previous versions.
+- [ ] My code follows the code style of this project
+- [ ] I have merged commits that are meaningless for follow-up work and confirmed that they will not cause damage to follow-up maintenance
--- a/.github/workflows/auto_close_issues.yml
+++ b/.github/workflows/auto_close_issues.yml
@@ -0,0 +1,23 @@
+name: Check Issues
+
+on:
+  issues:
+    types: [opened]
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out
+        uses: actions/checkout@v2
+      - if: contains(github.event.issue.body, 'ejfweaxptgrsgxed' ) == false
+        id: close
+        name: Close Issue(template)
+        uses: peter-evans/close-issue@v1
+        with:
+          comment: This issue is being automatically closed because it does not follow the issue template.
+      - if: contains(github.event.issue.body, '最新版' ) 
+        id: close-latest-version
+        name: Close Issue(template)
+        uses: peter-evans/close-issue@v1
+        with:
+          comment: 我不知道什么是最新版捏，具体版本号pls
--- a/.github/workflows/check_commit_message.yml
+++ b/.github/workflows/check_commit_message.yml
@@ -0,0 +1,28 @@
+name: 'Commit Message Check'
+on: 
+  pull_request:
+jobs:
+  check-commit-message:
+    name: Check Commit Message
+    runs-on: ubuntu-latest 
+    steps:
+        - name: Check Commit Message [skip CI]
+          env: 
+            COMMIT_FILTER: "[skip ci]"
+          if: "contains(github.event.head_commit.message, '[skip ci]')"
+          run: | 
+            echo "no 'skip ci' in commit message"
+            exit 2
+
+        - uses: actions-ecosystem/action-regex-match@v2
+          id: regex-match
+          with:
+            text: ${{ github.event.head_commit.message }}
+            regex: '[^\x00-\x7F]+'
+
+        - name: Check Commit Message [Non-ASCII]
+          if: ${{ steps.regex-match.outputs.match != '' }}
+          run: | 
+            echo "No Non-ASCII msg in commit message"
+            exit 2
+
--- a/README.md
+++ b/README.md
@@ -2,6 +2,10 @@

 [![license](https://img.shields.io/github/license/cinit/QAuxiliary.svg)](https://www.gnu.org/licenses/agpl-3.0.html)
 [![GitHub release](https://img.shields.io/github/release/cinit/QAuxiliary.svg)](https://github.com/cinit/QAuxiliary/releases/latest)
+[![Telegram](https://img.shields.io/static/v1?label=Telegram&message=Channel&color=0088cc)](https://t.me/QAuxiliary)
+[![Telegram](https://img.shields.io/static/v1?label=Telegram&message=Chat&color=0088cc)](https://t.me/QAuxiliaryChat)
+
+-----

 QAuxiliary 是一个基于 QNotified 的开源 Xposed 模块

@@ -54,6 +58,8 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.

 ## 发行渠道说明

+<details>
+
 QAuxiliary 采用滚动更新方式发布新版本，我们总是推荐用户使用最新版 QAuxiliary，无论您的 QQ 或者 TIM 客户端是哪个版本。

 QAuxiliary 将为分 `CI` 和 `推荐的CI` 两个版本
@@ -74,14 +80,16 @@ QAuxiliary 将为分 `CI` 和 `推荐的CI` 两个版本
 - 其中 major 为 主版本号，minor 为 次版本号，bugfix 为修正版本号；
 - 所有版本更新的`rev`为 commit 计数，`commit` 位都会是触发此次更新的Commit的hash的前7位。

-1. [QAuxiliary 频道](https://t.me/QAuxiliary) 将只发布 `推荐的CI` 版更新。
+1. [![Telegram](https://img.shields.io/static/v1?label=Telegram&message=QAuxiliary频道&color=0088cc)](https://t.me/QAuxiliary) 将只发布 `推荐的CI` 版更新。

-2. [QAuxiliary_CI 频道](https://t.me/QAuxiliary_CI) 发布 `CI` 版更新。
+2. [![Telegram](https://img.shields.io/static/v1?label=Telegram&message=QAuxiliary_CI频道&color=0088cc)](https://t.me/QAuxiliary_CI) 发布 `CI` 版更新。

-3. [Github Releases](https://github.com/cinit/QAuxiliary/releases/) 将只发布 `推荐的CI` 版更新。
+3. [![GitHub release](https://img.shields.io/github/release/cinit/QAuxiliary.svg)](https://github.com/cinit/QAuxiliary/releases/latest) 将只发布 `推荐的CI` 版更新。

-4. [LSPosed 仓库](https://github.com/Xposed-Modules-Repo/io.github.qauxv/releases/)
-   将发布所有版本更新，其中`CI`版本更新将被标注为 Pre-release。
+4. ![](https://img.shields.io/badge/LSPosed-ClickMe-blue?link=https://github.com/Xposed-Modules-Repo/io.github.qauxv/releases/) 将发布所有版本更新，其中`CI`版本更新将被标注为 Pre-release。
+</details>
+
+-----

 ## 赞助