From ddfbe547e1cac8b9d8cc9f04794dce54709f1118 Mon Sep 17 00:00:00 2001 From: MoonLeeeaf <150461955+MoonLeeeaf@users.noreply.github.com> Date: Sun, 19 May 2024 13:47:08 +0800 Subject: [PATCH] chore: readme --- .github/QA.md | 39 +++++++++++++++++++++++++++++++++++++++ readme.md | 14 ++++---------- 2 files changed, 43 insertions(+), 10 deletions(-) create mode 100644 .github/QA.md diff --git a/.github/QA.md b/.github/QA.md new file mode 100644 index 0000000..324b738 --- /dev/null +++ b/.github/QA.md @@ -0,0 +1,39 @@ +### Q&A + +#### 1. 协助项目 + +1. 若修改代码,请务必添加注释或者尽可能让方法名能被人所理解 + +2. 修改 readme 相关时,请不要留废话 + +3. 其它非代码注明性注释会不定期清理 + +4. 待补充 + +#### 2. 商业用途 + +不建议,不推荐,不赞同用于商业用途, 本项目的设计初衷是为了个人和团队使用, 而非用于圈钱, 因此如果确实需要商业化, 请考虑其他项目 + +因为这个项目还在初级阶段, 还有很多地方不够完善, 甚至有很多漏洞被利用, 造成不必要的损失 + +#### 3. 提问 + +1. 禁止人身攻击性回复 + +2. 请详细说明你的问题 + +3. 漏洞、BUG 类请给出代码位置 + +#### 4. 功能请求 + +目前不考虑,因为每一个做开源的人都应该以生活,以自己的感受为本 + +就像 weishu 大佬所说的: + +> 我发现很多搞开源的开发者都把自己弄得很累 +> 其实你把它当作是钓鱼,摩托,音响,单反那样的兴趣爱好就好多了 +> 既然是爱好,就不要搞得像打第二份工一样,开心了就玩,玩腻了就扔一边 + +另外如果你提交功能 PR,我有可能会直接 Close,我没有太多精力去维护一个用不上的功能 + +#### 5. 待补充 diff --git a/readme.md b/readme.md index 96b038a..b54f548 100644 --- a/readme.md +++ b/readme.md @@ -5,9 +5,9 @@ > [!NOTE] > 本项目仍在实验阶段, [点我](final.md)可查看进展 > -> 如果发现有任何疑问, 欢迎提问 +> 如果有任何问题,欢迎你提出来,我会不定时查看 > -> 另外 Android 客户端也在开发, 但因为从头开始写且生地中考临近, 因此暂时搁置 +> 另外 Android 客户端也在开发, 但进展缓慢 ### 使用 @@ -25,16 +25,10 @@ * 静态网页 (不推荐, 有跨域问题) +### [Q&A](.github/QA.md) + ### 鸣谢 WIP ### [你知道吗](.github/do_you_know.md) - -### 温馨提示 - -不建议,不推荐,不赞同用于商业用途, 本项目的设计初衷是为了个人和团队使用, 而非用于圈钱, 因此如果确实需要商业化, 请考虑其他项目 - -为什么? 因为这个项目还在初级阶段, 还有很多地方不够完善, 甚至有可能被一些 Hacker 抓到漏洞, 造成不必要的损失 - -因此我更建议个人及团队内部使用, 亦或者加密后放在公网使用