22 lines
1.2 KiB
Markdown
22 lines
1.2 KiB
Markdown
# 贡献指南
|
||
|
||
感谢参与 Open AI Canvas。提交改动前，请先确认相关 Issue 或用简短说明描述问题、目标和外部行为变化。
|
||
|
||
## 开发环境
|
||
|
||
- 前端：Bun、Vite、React、TypeScript。
|
||
- 后端：Go、Gin、GORM、SQLite。
|
||
- 本地全栈：`docker compose up -d --build`。
|
||
|
||
不要提交 `.env`、数据库、数据目录、生成产物、编辑器配置或真实 API/OSS 密钥。新增配置项时只在 `.env.example` 中提供无敏感信息的说明。
|
||
|
||
## 提交要求
|
||
|
||
- 保持改动聚焦，沿用现有目录职责、命名和错误处理风格。
|
||
- 写路径必须明确失败；不可用默认值掩盖保存、权限、生成或删除错误。
|
||
- 后端对象读取必须同时校验当前用户和资源归属。
|
||
- 涉及上传、外部请求或模型调用时，必须说明大小、频率、费用和 SSRF 边界。
|
||
- 用户可见文案使用中文；核心业务入口和安全边界使用简短中文注释说明原因。
|
||
|
||
Pull Request 应包含改动摘要、风险、验证方式和必要截图。提交即表示你有权按本项目 AGPL-3.0 许可证贡献相关代码或素材，并保留已有上游署名和许可证通知。
|