Skip to content

Commit 317d20a

Browse files
359392475-blue-sky359392475-blue-sky
committed
Improve open-source project hygiene
1 parent e170c99 commit 317d20a

9 files changed

Lines changed: 233 additions & 18 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Bug report
2+
description: Report a reproducible problem.
3+
title: "[Bug]: "
4+
labels:
5+
- bug
6+
body:
7+
- type: input
8+
id: version
9+
attributes:
10+
label: Version or commit
11+
placeholder: "Example: v0.1.0"
12+
validations:
13+
required: true
14+
- type: input
15+
id: environment
16+
attributes:
17+
label: Environment
18+
placeholder: "Example: macOS 15, Python 3.11, Chrome"
19+
validations:
20+
required: true
21+
- type: dropdown
22+
id: input_type
23+
attributes:
24+
label: Input type
25+
options:
26+
- Article URL
27+
- Pasted text
28+
- Other
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: steps
33+
attributes:
34+
label: Steps to reproduce
35+
description: Remove private family-chat content and API keys.
36+
validations:
37+
required: true
38+
- type: textarea
39+
id: expected
40+
attributes:
41+
label: Expected behavior
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: actual
46+
attributes:
47+
label: Actual behavior
48+
validations:
49+
required: true
50+
- type: textarea
51+
id: safety
52+
attributes:
53+
label: Safety impact
54+
description: Did this affect warnings, watermarks, safety filters, or generated content labels?

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Feature request
2+
description: Suggest a feature or safety improvement.
3+
title: "[Feature]: "
4+
labels:
5+
- enhancement
6+
body:
7+
- type: textarea
8+
id: problem
9+
attributes:
10+
label: Problem
11+
description: What media-literacy or product problem would this solve?
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: proposal
16+
attributes:
17+
label: Proposed solution
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: safety
22+
attributes:
23+
label: Safety considerations
24+
description: How should the feature avoid unmarked misinformation, harassment, or high-risk content?
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: context
29+
attributes:
30+
label: Context

‎.github/pull_request_template.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## Summary
2+
3+
Describe the change and why it is needed.
4+
5+
## Safety Impact
6+
7+
Explain any impact on:
8+
9+
- Satire labels
10+
- Warning injection
11+
- Safety filters
12+
- Prompt behavior
13+
- HTML/image output
14+
15+
## Test Plan
16+
17+
- [ ] `python -m compileall 源码/后端`
18+
- [ ] Manual URL input tested, if parsing changed
19+
- [ ] Manual pasted-text input tested, if generation changed
20+
- [ ] Screenshots included for UI changes
21+
22+
## Notes
23+
24+
Do not include API keys, private family-chat content, or generated private images.

‎CONTRIBUTING.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing to 二舅妈急了
2+
3+
Thanks for helping improve this media-literacy satire tool.
4+
5+
## Good First Contributions
6+
7+
- Documentation improvements in Chinese or English.
8+
- Safer prompt wording.
9+
- Better safety filters for high-risk topics.
10+
- UI fixes for mobile browsers.
11+
- Tests for parsing, safety filtering, and output warnings.
12+
- Deployment notes for local-only or private-family use.
13+
14+
## Development
15+
16+
```bash
17+
cd 源码/后端
18+
python3 -m venv .venv
19+
source .venv/bin/activate
20+
pip install -e ".[dev]"
21+
python main.py
22+
```
23+
24+
Run basic checks:
25+
26+
```bash
27+
python -m compileall .
28+
ruff check .
29+
pytest
30+
```
31+
32+
## Pull Requests
33+
34+
1. Keep each pull request focused.
35+
2. Explain the safety impact of the change.
36+
3. Do not remove satire labels, warning text, or watermarks.
37+
4. Include screenshots for UI changes.
38+
5. Do not commit `.env`, API keys, generated private content, or family-chat screenshots.
39+
40+
## Safety Boundary
41+
42+
This project is for media-literacy education. Contributions that make it easier to produce unmarked misinformation, harassment, or political manipulation will not be accepted.

‎LICENSE‎

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2026 二舅妈急了 项目贡献者
3+
Copyright (c) 2026 Wang Junjie
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal
@@ -19,18 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2121
SOFTWARE.
22-
23-
————————————————————————————————————————————————————————
24-
25-
伦理使用声明（项目作者额外约定）：
26-
27-
本项目本质是"以毒攻毒"——通过 AI 生成立场反转的"伪权威"反讽内容，
28-
让长辈感受被假权威信息包围的荒谬，从而培养信息核实意识。
29-
30-
使用本项目时，请遵守：
31-
1. 仅用于个人媒介素养训练 / 私域使用，不大规模分发
32-
2. 不得移除生成内容中的"AI 生成 · 反讽辟谣作品"标识与底部红色警示语
33-
3. 不得用于政治、宗教、民族议题的反讽（涉及合规风险）
34-
4. 不得用于恶意攻击特定个人或机构
35-
36-
违反上述使用约定造成的后果，使用者自负。

‎README.md‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
把"伪权威"养生谣言一键反转成立场完全相反的"专家"反讽内容，<br/>
1010
用相同形态发回家族群——以毒攻毒，让长辈感受被假权威信息包围的荒谬。
1111

12+
**English summary:** Aunt Panic is an open-source media-literacy satire tool for Chinese family-chat misinformation. It takes a viral health-rumor article or pasted message, generates a clearly marked opposite-position satire version, and injects warnings so the output is understood as AI-generated media-literacy material, not a fact-checking authority.
13+
1214
[![Python](https://img.shields.io/badge/Python-3.11+-3776AB?logo=python&logoColor=white)](https://www.python.org)
1315
[![FastAPI](https://img.shields.io/badge/FastAPI-0.115-009688?logo=fastapi&logoColor=white)](https://fastapi.tiangolo.com)
1416
[![DeepSeek](https://img.shields.io/badge/LLM-DeepSeek-0F8FE8)](https://api.deepseek.com)
@@ -68,6 +70,19 @@
6870

6971
---
7072

73+
## 🛡️ 安全与伦理边界
74+
75+
本项目不是专业事实核查机构、医疗建议工具、法律建议工具或新闻机构。输出内容必须被视为 **AI 生成的反讽媒介素养材料**，分享前需要人工检查。
76+
77+
- 不要移除 AI 生成标识、反讽说明、水印或底部警示语
78+
- 不要用于政治、宗教、民族、身份攻击或大规模传播
79+
- 不要用于骚扰特定个人或机构
80+
- 不要把生成内容包装成真实新闻、权威建议或专业事实核查结论
81+
82+
完整说明见 [USAGE_POLICY.md](USAGE_POLICY.md)。
83+
84+
---
85+
7186
## 🚀 快速开始
7287

7388
### 准备
@@ -298,7 +313,7 @@ POST /api/generate {input: ...}
298313

299314
[MIT](LICENSE) © 2026 二舅妈急了 项目贡献者
300315

301-
License 中包含**伦理使用声明**，使用前请阅读。
316+
负责任使用边界见 [USAGE_POLICY.md](USAGE_POLICY.md)。
302317

303318
---
304319

‎SECURITY.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Security Policy
2+
3+
This project handles user-submitted text and article URLs, calls an LLM provider, and can render generated HTML to images. Please treat prompt safety, input handling, and credential handling seriously.
4+
5+
## Supported Versions
6+
7+
Security fixes are considered for the latest public release and the current `main` branch.
8+
9+
| Version | Supported |
10+
| --- | --- |
11+
| v0.1.x | Yes |
12+
13+
## Reporting a Vulnerability
14+
15+
Please do not open a public GitHub issue for vulnerabilities.
16+
17+
Contact the maintainer through GitHub:
18+
19+
- https://github.com/359392475-blue-sky
20+
21+
Include:
22+
23+
- A short description.
24+
- Reproduction steps.
25+
- Affected version or commit.
26+
- Potential impact.
27+
- Suggested fix, if known.
28+
29+
## In Scope
30+
31+
- API key leakage.
32+
- Unsafe file or image handling.
33+
- HTML rendering issues with security impact.
34+
- Server-side request handling issues.
35+
- Bypass of required satire labels or warning injection.
36+
37+
## Out of Scope
38+
39+
- General disagreement with generated satire tone.
40+
- Incorrect claims in generated output without a security impact.
41+
- Public deployment hardening for environments not described in the README.

‎USAGE_POLICY.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Usage Policy
2+
3+
`二舅妈急了` is a media-literacy satire tool. It creates clearly marked AI-generated satire so families can discuss why fake "expert" content and unsourced viral health claims are dangerous.
4+
5+
## Intended Use
6+
7+
- Personal media-literacy education.
8+
- Small private-family discussions.
9+
- Demonstrations of how easy AI-generated misinformation can look convincing.
10+
- Teaching users to check sources, authorship, institutions, and evidence.
11+
12+
## Do Not Use This Project For
13+
14+
- Political, religious, ethnic, or identity-based manipulation.
15+
- Harassment of specific people or organizations.
16+
- Mass distribution of synthetic misinformation.
17+
- Removing AI-generated satire labels, warnings, or watermarks.
18+
- Presenting generated output as verified fact-checking.
19+
20+
## Important Disclaimer
21+
22+
This project is not a professional fact-checking authority, legal advisor, medical advisor, or news organization. Generated content must be treated as AI-generated satire and reviewed before sharing.
23+
24+
The MIT License covers the software. This usage policy explains the maintainer's intended safety boundary for responsible use.

‎源码/后端/.env.example‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# 复制为 .env 后填入真实值，.env 不要提交到 git
22

33
# ========== DeepSeek ==========
4-
DEEPSEEK_API_KEY=sk-xxxxxxxxxxxxxxxxxxxx
4+
DEEPSEEK_API_KEY=your_deepseek_api_key_here
55
DEEPSEEK_BASE_URL=https://api.deepseek.com
66
DEEPSEEK_MODEL=deepseek-chat
77

0 commit comments

Comments
 (0)