chore: prepare project for open source release

- Remove internal planning docs (CLAUDE.md, docs/, feature.md, livePlan.md) from git tracking
- Add .gitignore rules to prevent re-tracking internal files
- Add README.md (Chinese) and README.en.md (English) with screenshots, features, quick start
- Add LICENSE (MIT)
- Add CONTRIBUTING.md with dev setup, commit conventions, PR guide
- Add CHANGELOG.md for v1.0.0
- Add .github/ issue templates (bug report, feature request) and PR template
- Add public/ screenshots (p1-p6)
This commit is contained in:
Developer
2026-03-20 12:03:24 +08:00
parent 5ec4c5a6be
commit ff5860d3c7
25 changed files with 680 additions and 2473 deletions

68
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@@ -0,0 +1,68 @@
name: Bug 报告
description: 报告一个 Bug
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
感谢你提交 Bug 报告!请尽量填写完整信息,帮助我们更快定位问题。
- type: dropdown
id: platform
attributes:
label: 运行平台
options:
- AndroidDev Build
- AndroidExpo Go
- iOSDev Build
- iOSExpo Go
- Web
validations:
required: true
- type: dropdown
id: category
attributes:
label: 问题分类
options:
- 视频播放
- 直播
- 弹幕
- 登录 / 账号
- 下载
- UI / 界面
- 其他
validations:
required: true
- type: textarea
id: description
attributes:
label: 问题描述
placeholder: 请描述你遇到的问题...
validations:
required: true
- type: textarea
id: steps
attributes:
label: 复现步骤
placeholder: |
1. 打开 App
2. 点击 ...
3. 发现 ...
validations:
required: true
- type: textarea
id: expected
attributes:
label: 期望行为
placeholder: 你期望发生什么?
- type: textarea
id: logs
attributes:
label: 错误日志 / 截图
description: 如有控制台报错或截图,请粘贴在此
render: shell

View File

@@ -0,0 +1,41 @@
name: 功能建议
description: 建议一个新功能或改进
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
感谢你的建议!在提交前请先搜索现有 Issue避免重复。
- type: textarea
id: problem
attributes:
label: 需求背景
placeholder: 这个功能解决了什么问题?目前的痛点是什么?
validations:
required: true
- type: textarea
id: solution
attributes:
label: 建议方案
placeholder: 你期望的功能是怎样的?
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: 替代方案
placeholder: 你是否考虑过其他方案?
- type: dropdown
id: contribute
attributes:
label: 是否愿意提交 PR
options:
- 是,我愿意实现这个功能
- 否,希望维护者实现
- 不确定
validations:
required: true

30
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,30 @@
## 改动说明
> 简要描述本次 PR 做了什么
## 改动类型
- [ ] Bug 修复
- [ ] 新功能
- [ ] 重构(不改变功能)
- [ ] 文档更新
- [ ] 其他:
## 关联 Issue
> 关闭 #Issue 编号)
## 测试平台
- [ ] AndroidDev Build
- [ ] AndroidExpo Go
- [ ] iOS
- [ ] Web
## 截图 / 录屏(如适用)
## 注意事项
- [ ] 代码中无硬编码账号信息SESSDATA、uid 等)
- [ ] Commit 信息符合 Conventional Commits 规范
- [ ] 已在本地测试通过