Skip to content

Commit d8ee0e4

Browse files
author
ukgorclawbot-stack
committed
Add code of conduct and FAQ
1 parent bbc7b0c commit d8ee0e4

5 files changed

Lines changed: 166 additions & 0 deletions

File tree

‎CODE_OF_CONDUCT.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Code of Conduct
2+
3+
This project aims to be welcoming, practical, and respectful.
4+
5+
## Our Standards
6+
7+
Examples of behavior that help build a good community:
8+
9+
- being respectful and constructive
10+
- giving actionable technical feedback
11+
- assuming good intent
12+
- keeping pull requests focused and reviewable
13+
- reporting bugs with reproducible steps
14+
15+
Examples of unacceptable behavior:
16+
17+
- harassment or personal attacks
18+
- insulting or dismissive language
19+
- intentionally leaking secrets or private information
20+
- submitting malicious code or misleading fixes
21+
- derailing technical discussion with hostility
22+
23+
## Scope
24+
25+
This code of conduct applies to:
26+
27+
- GitHub issues
28+
- pull requests
29+
- discussions around this repository
30+
31+
## Enforcement
32+
33+
Project maintainers may remove, edit, or reject comments, issues, or pull requests that violate this code of conduct.
34+
35+
## Reporting
36+
37+
If you see unacceptable behavior:
38+
39+
1. document what happened
40+
2. include links or screenshots if relevant
41+
3. contact the maintainer privately when possible
42+
43+
If the report involves secrets or vulnerabilities, follow [SECURITY.md](./SECURITY.md) instead of filing a public issue first.

‎README.en.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ Language:
5959
- English install: [INSTALL.en.md](./INSTALL.en.md)
6060
- Contributing: [CONTRIBUTING.md](./CONTRIBUTING.md)
6161
- Security: [SECURITY.md](./SECURITY.md)
62+
- Code of Conduct: [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)
63+
- FAQ: [docs/faq.md](./docs/faq.md)
6264

6365
## Quick Start
6466

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
- English install: [INSTALL.en.md](./INSTALL.en.md)
2020
- 贡献指南：[CONTRIBUTING.md](./CONTRIBUTING.md)
2121
- 安全说明：[SECURITY.md](./SECURITY.md)
22+
- 行为准则：[CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)
23+
- 常见问题：[docs/faq.md](./docs/faq.md)
2224

2325
适合这些场景：
2426
- 团队协作群里的任务拆分和汇报

‎RELEASE_NOTES_v0.1.5.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Telegram Multi-Bot Stack v0.1.5
2+
3+
This release improves public project structure for community onboarding.
4+
5+
## What's New
6+
7+
- Added `CODE_OF_CONDUCT.md`
8+
- Added `docs/faq.md`
9+
- Linked both files from the Chinese and English README
10+
11+
## Why This Matters
12+
13+
- new contributors can understand community expectations quickly
14+
- new users can find common answers without asking maintainers first
15+
- the repository looks and behaves more like a complete public open-source project
16+
17+
## Quick Start
18+
19+
```bash
20+
git clone https://github.com/ukgorclawbot-stack/telegram-multi-bot-stack.git
21+
cd telegram-multi-bot-stack
22+
bash ./install.sh
23+
bash ./configure.sh
24+
bash ./apply_stack.sh
25+
```

‎docs/faq.md‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
# FAQ
2+
3+
## 1. Do I need exactly 6 bots?
4+
5+
No.
6+
7+
The repository ships with a recommended 6-bot layout, but the stack generator supports custom bot counts and custom combinations of roles.
8+
9+
## 2. Which file should I edit first?
10+
11+
For most users, start with:
12+
13+
- `bash ./install.sh`
14+
- `bash ./configure.sh`
15+
16+
You usually do not need to hand-edit `bot_stack.bootstrap.toml` on day one.
17+
18+
## 3. Where do I put Telegram bot tokens?
19+
20+
Put them in:
21+
22+
- `.bot_tokens.env`
23+
24+
Do not commit this file.
25+
26+
## 4. Why are there both group bots and private bots?
27+
28+
Because group-chat responsibilities and private-chat responsibilities are usually different.
29+
30+
Typical split:
31+
32+
- group bots: routing, reporting, teamwork
33+
- private bots: deeper execution and higher-permission personal workflows
34+
35+
## 5. What does the health check script do?
36+
37+
`bash ./health_check.sh` checks:
38+
39+
- Telegram API reachability
40+
- local proxy state
41+
- bot service status
42+
- monitor output freshness
43+
- report output freshness
44+
45+
## 6. What does reverse export do?
46+
47+
It converts a live local stack into a sanitized TOML file so you can:
48+
49+
- document your current running setup
50+
- rebuild it later
51+
- create migration-ready templates
52+
53+
## 7. What does the migration-ready template do?
54+
55+
It rewrites a reverse-exported stack into a new-machine template with placeholder paths such as `/Users/your_user/...`.
56+
57+
This is useful when you want to:
58+
59+
- move to a new Mac
60+
- share a sanitized deployment template
61+
- bootstrap a second machine faster
62+
63+
## 8. Does CI start my real bots?
64+
65+
No.
66+
67+
CI only runs lightweight validation:
68+
69+
- Python syntax checks
70+
- shell syntax checks
71+
- local config generation
72+
- stack generation
73+
- reverse export
74+
- migration template generation
75+
76+
It does not start your real local Telegram services.
77+
78+
## 9. What files should never be committed?
79+
80+
Never commit:
81+
82+
- `.bot_tokens.env`
83+
- real secrets
84+
- runtime sqlite files
85+
- generated logs
86+
- private local runtime data
87+
88+
## 10. Where should I report a vulnerability?
89+
90+
Follow:
91+
92+
- [SECURITY.md](../SECURITY.md)
93+
94+
Do not post sensitive exploit details in a public issue first.

0 commit comments

Comments
 (0)