Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# EditorConfig is awesome: https://EditorConfig.org
# 跨编辑器 / IDE 的代码格式配置文件

root = true

[*]
charset = utf-8
indent_style = space
indent_size = 4
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.{js,jsx,ts,tsx,vue,json,css,scss,less,html,md,yml,yaml}]
indent_size = 2

[*.{py}]
indent_size = 4

[Makefile]
indent_style = tab
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Bug Report (问题报告)
description: 提交运行错误、异常行为或缺陷
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
感谢你帮助改进本项目!提交 Bug 前请先在已有的 Issue 中搜索是否已有相同问题。
- type: textarea
id: description
attributes:
label: 问题描述 (Description)
description: 请清晰、简要地描述遇到的问题或异常行为。
placeholder: 在执行 ... 时出现了 ...
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: 复现步骤 (Steps to Reproduce)
description: 请提供逐步复现该问题的详细步骤。
placeholder: |
1. 运行 '...'
2. 点击 '...'
3. 查看错误信息
validations:
required: true
- type: textarea
id: expected
attributes:
label: 预期行为 (Expected Behavior)
description: 描述你期望发生的结果。
validations:
required: false
- type: textarea
id: logs
attributes:
label: 错误日志与堆栈 (Logs / Traceback)
description: 请粘贴相关终端输出、Docker 容器日志或浏览器控制台报错。
render: shell
validations:
required: false
- type: textarea
id: environment
attributes:
label: 运行环境 (Environment)
description: 系统与依赖环境信息。
value: |
- OS: [e.g. Ubuntu 22.04 / macOS 14 / Windows 11]
- Docker Version: [e.g. 24.0.5]
- Browser / Node / Python Version:
validations:
required: true
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Feature Request (功能需求)
description: 提出新的功能建议或改进想法
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
我们欢迎任何有助于提升产品体验或拓展生态能力的建议!
- type: textarea
id: problem
attributes:
label: 目标场景与痛点 (Problem / Motivation)
description: 该功能旨在解决什么问题?或在什么场景下会用到?
placeholder: 我希望在 ... 时能够 ...,因为目前 ...
validations:
required: true
- type: textarea
id: solution
attributes:
label: 建议的方案 (Proposed Solution)
description: 请清晰描述你希望的功能实现方式或用户体验。
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: 考虑过的替代方案 (Alternatives Considered)
description: 是否考虑过其他临时绕过方式或现有工具?
validations:
required: false
22 changes: 22 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## 变更说明 (Description)
<!-- 请简要描述本次 PR 的改动内容、解决的痛点或实现的功能 -->

## 关联 Issue (Related Issue)
<!-- 例如 Fixes #123, Closes #456 -->

## 变更类型 (Type of Change)
- [ ] 🐛 Bug 修复 (Bug fix)
- [ ] ✨ 新功能 (New feature)
- [ ] 📝 文档更新 (Documentation update)
- [ ] 🎨 代码风格/重构 (Refactoring / Code style)
- [ ] ⚡ 性能优化 (Performance improvement)
- [ ] 🔧 构建/配置/CI (Build / CI / Chores)

## 验证与测试 (Verification)
<!-- 描述所做的验证测试,例如运行的测试命令与测试结果 -->
- [ ] 本地测试通过 (测试套件全绿)
- [ ] 代码符合仓库规范(通过 Linter 检查)
- [ ] 文档已同步更新(若涉及接口或配置变动)

## 其他说明 (Notes)
<!-- 如有特殊注意事项或对评审者的说明,请在此备注 -->
40 changes: 40 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# 贡献指南 (Contributing Guide)

感谢你关注并愿意为本项目贡献力量!本项目是 **\*Flow 生态** 的一部分,致力于提供轻量、本地优先与 Agent 原生的研发与生产力工作流。

## 提交前准备

1. **查阅 Issue**:在提交重大功能或重构前,请先创建 Issue 进行方案讨论。
2. **规范阅读**:请阅读 [AGENTS.md](AGENTS.md) 以及 `docs/` 目录下的相关规范与架构设计文档。

## 研发工作流

1. **Fork & Clone**:Fork 本仓库并 Clone 到本地。
2. **创建特性分支**:
```bash
git checkout -b feature/your-feature-name
# 或
git checkout -b fix/your-bug-fix
```
3. **环境与依赖**:
- 请根据项目 README 配置本地依赖与 `.env` 文件。
- 绝不提交真实的 Secret、API Key 或生产数据。
4. **代码风格与检查**:
- 提交前请确保运行门禁检查命令通过。
- Python 代码遵循 Ruff 规则与 PEP 8 标准。
- TypeScript/前端代码遵循 ESLint 与 Prettier 格式。
5. **提交规范 (Commit Convention)**:
提交信息推荐遵循 Conventional Commits:
- `feat: 新增功能`
- `fix: 修复 Bug`
- `docs: 更新文档`
- `style: 格式与代码风格变动`
- `refactor: 代码重构`
- `test: 增加或修改测试`
- `chore: 构建或辅助工具变动`

## Pull Request 流程

1. 确保你的分支与 upstream `main` 保持最新。
2. 填写完整的 PR 模板,并关联相关 Issue。
3. 等待 CI 自动化流水线验证通过。
42 changes: 21 additions & 21 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
MIT License
Copyright (c) 2026 mcocdaa
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
MIT License

Copyright (c) 2026 mcocdaa

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
# MeetFlow

> 轻量级多人共享会议档案、结构化行动项追踪与团队知识沉淀系统。

[![Family: *Flow](https://img.shields.io/badge/family-*Flow-8A2BE2.svg)](https://github.com/mcocdaa)
[![CI](https://github.com/mcocdaa/MeetFlow/actions/workflows/ci.yml/badge.svg)](https://github.com/mcocdaa/MeetFlow/actions/workflows/ci.yml)
[![Release](https://img.shields.io/github/v/release/mcocdaa/MeetFlow?display_name=tag&sort=semver)](https://github.com/mcocdaa/MeetFlow/releases)
[![Container image](https://img.shields.io/badge/image-ghcr.io%2Fmcocdaa%2Fmeetflow-0b6a58)](https://github.com/mcocdaa/MeetFlow/pkgs/container/meetflow)
[![License](https://img.shields.io/github/license/mcocdaa/MeetFlow)](LICENSE)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
[![Python 3.12](https://img.shields.io/badge/python-3.12-blue.svg)](https://www.python.org/)
[![Docker](https://img.shields.io/badge/docker-ready-blue.svg)](compose.yaml)

MeetFlow 是一个轻量级多人共享会议档案工具。一次会议可以保存 Markdown 原始记录、关键结论、结构化行动项、后续补充、图片与小文件。所有成员使用同一个共享工作区;管理员负责账号审批和插件配置。

Expand Down
17 changes: 17 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# 安全策略 (Security Policy)

## 漏洞报告 (Reporting a Vulnerability)

如果您在本项目中发现了安全漏洞或潜在的风险点,请**不要**直接公开创建 Issue。

请通过以下安全渠道联系项目维护者:
- **Email**: 通过维护者 GitHub 个人主页公开渠道或私信联系 (`mcocdaa`)
- **GitHub Private Vulnerability Reporting**: 在仓库的 **Security** -> **Advisories** 中提交私密漏洞报告

### 报告时请提供以下信息:
1. 漏洞类型及严重程度评估
2. 受影响的组件、文件或 API 端点
3. 详细的复现步骤或最小可复现示例 (PoC)
4. 任何可能的修复建议或缓解措施

维护团队将在 48 小时内确认并评估漏洞,并在发布修复版本后妥善致谢。
Loading
Loading