Skip to content

Commit e5d7d05

Browse files
author
ukgorclawbot-stack
committed
Add changelog and collaboration templates
1 parent d8ee0e4 commit e5d7d05

File tree

7 files changed

+167
-0
lines changed

7 files changed

+167
-0
lines changed
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Bug report
3+
about: Report a reproducible problem in the stack
4+
title: "[Bug] "
5+
labels: bug
6+
assignees: ""
7+
---
8+
9+
## Summary
10+
11+
What is broken?
12+
13+
## Environment
14+
15+
- macOS version:
16+
- Python version:
17+
- How did you install the project:
18+
19+
## Steps to Reproduce
20+
21+
1.
22+
2.
23+
3.
24+
25+
## Expected Result
26+
27+
What should have happened?
28+
29+
## Actual Result
30+
31+
What happened instead?
32+
33+
## Logs or Error Messages
34+
35+
Paste only sanitized logs. Do not include secrets or bot tokens.
36+
37+
## Additional Context
38+
39+
Anything else that will help reproduce the issue?
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Feature request
3+
about: Suggest an improvement or a new capability
4+
title: "[Feature] "
5+
labels: enhancement
6+
assignees: ""
7+
---
8+
9+
## Summary
10+
11+
What do you want to add or improve?
12+
13+
## Problem
14+
15+
What problem does this solve?
16+
17+
## Proposed Solution
18+
19+
Describe the change you want.
20+
21+
## Alternatives Considered
22+
23+
What other options did you consider?
24+
25+
## Extra Context
26+
27+
Add examples, screenshots, or links if useful.

.github/pull_request_template.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## Summary
2+
3+
Describe the change in one short paragraph.
4+
5+
## What Changed
6+
7+
-
8+
9+
## Why
10+
11+
Why is this change needed?
12+
13+
## Validation
14+
15+
List the commands or checks you ran.
16+
17+
```bash
18+
# example
19+
python3 -m py_compile ...
20+
bash -n ...
21+
```
22+
23+
## Checklist
24+
25+
- [ ] Change is focused and reviewable
26+
- [ ] No secrets were added
27+
- [ ] Docs were updated if behavior changed
28+
- [ ] Fast local checks passed

CHANGELOG.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Changelog
2+
3+
All notable changes to this public repository are documented here.
4+
5+
## v0.1.6
6+
7+
- added `CHANGELOG.md`
8+
- added GitHub bug report template
9+
- added GitHub feature request template
10+
- added GitHub pull request template
11+
12+
## v0.1.5
13+
14+
- added `CODE_OF_CONDUCT.md`
15+
- added `docs/faq.md`
16+
- linked conduct and FAQ docs from Chinese and English README
17+
18+
## v0.1.4
19+
20+
- added `CONTRIBUTING.md`
21+
- added `SECURITY.md`
22+
- linked contributing and security docs from Chinese and English README
23+
24+
## v0.1.3
25+
26+
- added `Release` badge to both README files
27+
- added 6-bot architecture diagram to both README files
28+
29+
## v0.1.2
30+
31+
- added standalone English install guide `INSTALL.en.md`
32+
- added CI badge to both README files
33+
34+
## v0.1.1
35+
36+
- added GitHub Actions CI
37+
- expanded `INSTALL.md` into a bilingual Chinese and English guide
38+
39+
## v0.1.0
40+
41+
- initial public release
42+
- one-command install/configure/apply flow
43+
- stack generation and migration tooling
44+
- public documentation and release notes baseline

README.en.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ Language:
6161
- Security: [SECURITY.md](./SECURITY.md)
6262
- Code of Conduct: [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)
6363
- FAQ: [docs/faq.md](./docs/faq.md)
64+
- Changelog: [CHANGELOG.md](./CHANGELOG.md)
6465

6566
## Quick Start
6667

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
- 安全说明:[SECURITY.md](./SECURITY.md)
2222
- 行为准则:[CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)
2323
- 常见问题:[docs/faq.md](./docs/faq.md)
24+
- 更新记录:[CHANGELOG.md](./CHANGELOG.md)
2425

2526
适合这些场景:
2627
- 团队协作群里的任务拆分和汇报

RELEASE_NOTES_v0.1.6.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Telegram Multi-Bot Stack v0.1.6
2+
3+
This release improves public collaboration workflow.
4+
5+
## What's New
6+
7+
- added `CHANGELOG.md`
8+
- added GitHub issue templates
9+
- added GitHub pull request template
10+
- linked changelog from Chinese and English README
11+
12+
## Why This Matters
13+
14+
- contributors can report bugs more cleanly
15+
- feature requests become easier to triage
16+
- pull requests have a clearer review structure
17+
- release history is now easier to scan from the repository itself
18+
19+
## Quick Start
20+
21+
```bash
22+
git clone https://github.com/ukgorclawbot-stack/telegram-multi-bot-stack.git
23+
cd telegram-multi-bot-stack
24+
bash ./install.sh
25+
bash ./configure.sh
26+
bash ./apply_stack.sh
27+
```

0 commit comments

Comments
 (0)