Skip to content

Commit 5b4704c

Browse files
committed
fix readme
1 parent 7f8e824 commit 5b4704c

6 files changed

Lines changed: 95 additions & 0 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Summary
2+
- What changed?
3+
- Why is this needed?
4+
5+
## Related Issue
6+
- Closes #
7+
8+
## Changes
9+
- [ ] Feature
10+
- [ ] Bug fix
11+
- [ ] Refactor
12+
- [ ] Docs only
13+
14+
## Validation
15+
- [ ] Built locally
16+
- [ ] Tested key workflow manually
17+
- [ ] Added/updated tests (if applicable)
18+
19+
## UI Changes
20+
- [ ] N/A
21+
- [ ] Added screenshots or short GIF
22+
23+
## Checklist
24+
- [ ] Kept scope focused
25+
- [ ] Updated docs/readme if behavior changed
26+
- [ ] No secrets in code/logs/screenshots

CODE_OF_CONDUCT.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Code of Conduct
2+
3+
## Our Standard
4+
Please keep interactions respectful, constructive, and inclusive.
5+
6+
## Unacceptable Behavior
7+
- Harassment, insults, or discriminatory language
8+
- Personal attacks or intimidation
9+
- Sharing private information without consent
10+
- Repeated disruptive behavior
11+
12+
## Enforcement
13+
Maintainers may remove content or limit participation for violations.
14+
15+
## Reporting
16+
If you experience or witness unacceptable behavior, contact maintainers privately.

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@ A Windows desktop task manager built around the Eisenhower Matrix (Important/Urg
88

99
English | [简体中文](README.zh-CN.md)
1010

11+
## Project Status
12+
- Roadmap: [docs/ROADMAP.md](docs/ROADMAP.md)
13+
- Changelog: [CHANGELOG.md](CHANGELOG.md)
14+
- Contributing: [CONTRIBUTING.md](CONTRIBUTING.md)
15+
- Security: [SECURITY.md](SECURITY.md)
16+
- Code of Conduct: [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
17+
1118
## Download In 30 Seconds
1219
1. Go to [Latest Release](https://github.com/showkeyjar/TimeTask/releases/latest).
1320
2. Download `TimeTask-win-x64.zip`.

README.zh-CN.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@
99

1010
适用人群:希望把“任务执行 + 长期目标 + 提醒复盘”放在一个桌面工具里的 Windows 用户。
1111

12+
## 项目状态
13+
- 路线图: [docs/ROADMAP.md](docs/ROADMAP.md)
14+
- 更新日志: [CHANGELOG.md](CHANGELOG.md)
15+
- 贡献指南: [CONTRIBUTING.md](CONTRIBUTING.md)
16+
- 安全策略: [SECURITY.md](SECURITY.md)
17+
- 社区行为准则: [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
18+
1219
## 30 秒开始使用
1320

1421
1. 打开 [Releases](https://github.com/showkeyjar/TimeTask/releases/latest) 下载 `TimeTask-win-x64.zip`

SECURITY.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
- The latest release is supported for security fixes.
5+
6+
## Reporting A Vulnerability
7+
Please do not open public issues for security vulnerabilities.
8+
9+
Report privately to repository maintainers with:
10+
- Affected version
11+
- Reproduction steps
12+
- Impact assessment
13+
- Suggested fix (optional)
14+
15+
After receiving a report, maintainers will:
16+
1. Confirm receipt.
17+
2. Assess severity and impact.
18+
3. Prepare and release a fix.
19+
4. Publish a brief advisory once users can update.

docs/ROADMAP.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# TimeTask Roadmap
2+
3+
This is a short-term roadmap focused on practical delivery.
4+
5+
## Next 30 Days
6+
- Stabilize release packaging for every tag (`v*`) with downloadable zip assets.
7+
- Expand i18n coverage from main window to all major dialogs.
8+
- Improve first-run guidance and defaults for voice + reminders.
9+
- Add lightweight diagnostics for common setup failures.
10+
11+
## Next 60 Days
12+
- Better onboarding flow for long-term goals and learning plans.
13+
- Improve task decomposition quality and fallback behavior.
14+
- Add more user-facing examples and templates.
15+
16+
## Community Priorities
17+
If you want to influence priorities:
18+
- Open a feature request in Issues.
19+
- Vote/react on existing requests.
20+
- Share your real usage scenario.

0 commit comments

Comments
 (0)