GithubBackup/Foxel

Fork 0

mirror of https://github.com/DrizzleTime/Foxel.git synced 2026-05-07 05:32:49 +08:00

Files

shiyu 202c2ed5af docs: Update contributing guide, enhance README security advice

2025-08-26 11:58:33 +08:00

5.6 KiB

Raw Blame History

Contributing to Foxel

🎉 首先，非常感谢您愿意花时间为 Foxel 做出贡献！

我们热烈欢迎各种形式的贡献。无论是报告 Bug、提出新功能建议、完善文档，还是直接提交代码，都将对项目产生积极的影响。

本指南将帮助您顺利地参与到项目中来。

如何贡献

🐛 报告 Bug

如果您在使用的过程中发现了 Bug，请通过 GitHub Issues 来报告。请在报告中提供以下信息：

清晰的标题：简明扼要地描述问题。
复现步骤：详细说明如何一步步重现该 Bug。
期望行为 vs 实际行为：描述您预期的结果和实际发生的情况。
环境信息：例如操作系统、浏览器版本、Foxel 版本等。

✨ 提交功能建议

我们欢迎任何关于新功能或改进的建议。请通过 GitHub Issues 创建一个 "Feature Request"，并详细阐述您的想法：

问题描述：说明该功能要解决什么问题。
方案设想：描述您希望该功能如何工作。
相关信息：提供任何有助于理解您想法的截图、链接或参考。

🛠️ 贡献代码

如果您希望直接贡献代码，请参考下面的开发和提交流程。

开发环境搭建

依赖准备

Git: 用于版本控制。
Python: >= 3.13
Bun: 用于前端包管理和脚本运行。

后端 (FastAPI)

后端 API 服务基于 Python 和 FastAPI 构建。

克隆仓库

git clone https://github.com/DrizzleTime/foxel.git
cd Foxel

创建并激活 Python 虚拟环境

python3 -m venv .venv
source .venv/bin/activate
# On Windows: .venv\Scripts\activate

安装依赖
```
pip install -r requirements.txt
```
启动开发服务器
```
uvicorn main:app --reload --host 0.0.0.0 --port 8000
```
API 服务将在 http://localhost:8000 上运行，您可以通过 http://localhost:8000/docs 访问自动生成的 API 文档。

前端 (React + Vite)

前端应用使用 React, Vite, 和 TypeScript 构建。

进入前端目录
```
cd web
```
安装依赖
```
bun install
```
启动开发服务器
```
bun run dev
```
前端开发服务器将在 http://localhost:5173 运行。它已经配置了代理，会自动将 /api 请求转发到后端服务。

代码贡献指南

贡献存储适配器 (Adapter)

存储适配器是 Foxel 的核心扩展点，用于接入不同的存储后端 (如 S3, FTP, Alist 等)。

创建适配器文件: 在 services/adapters/ 目录下，创建一个新文件，例如 my_new_adapter.py。
实现适配器类:
- 创建一个类，继承自 services.adapters.base.BaseAdapter。
- 实现 BaseAdapter 中定义的所有抽象方法，如 list_dir, get_meta, upload, download 等。请仔细阅读基类中的文档注释以理解每个方法的作用和参数。

贡献前端应用 (App)

前端应用允许用户在浏览器中直接预览或编辑特定类型的文件。

创建应用组件: 在 web/src/apps/ 目录下，为您的应用创建一个新的文件夹，并在其中创建 React 组件。
定义应用类型: 您的应用需要实现 web/src/apps/types.ts 中定义的 FoxelApp 接口。
注册应用: 在 web/src/apps/registry.ts 中，导入您的应用组件，并将其添加到 APP_REGISTRY。在注册时，您需要指定该应用可以处理的文件类型（通过 MIME Type 或文件扩展名）。

提交规范

Git 分支管理

从最新的 main 分支创建您的特性分支。

Commit Message 格式

我们遵循 Conventional Commits 规范。这有助于自动化生成更新日志和版本管理。

Commit Message 格式如下:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

type: feat, fix, docs, style, refactor, test, chore 等。
scope: (可选) 本次提交影响的范围，例如 adapter, ui, api。
subject: 简明扼要的描述。

示例:

feat(adapter): Add support for Alist storage

fix(ui): Correct display issue in file list view

Pull Request 流程

Fork 仓库并克隆到本地。
创建并切换到您的特性分支。
完成代码编写和测试。
将您的分支推送到您的 Fork 仓库。
在 Foxel 主仓库创建一个 Pull Request，目标分支为 main。
在 PR 描述中清晰地说明您的更改内容、目的和任何相关的 Issue 编号。

项目维护者会尽快审查您的 PR。感谢您的耐心和贡献！

5.6 KiB Raw Blame History Unescape Escape