NOTE

You are currently viewing the documentation for Filament 4.x, which is a previous version of Filament.

Looking for the current stable version? Visit the 5.x documentation.

介绍

贡献

NOTE

本指南部分参考了 Laravel 的贡献指南,它提供了有价值的启发。

漏洞报告

如果你在 Filament 中发现了漏洞,请通过 GitHub 仓库 创建一个 issue 来报告它。在创建 issue 之前,请先搜索已存在的 issue 以检查该漏洞是否已被报告。

请包含尽可能多的信息,尤其是应用中的软件包的版本号。你可以在应用中使用 Artisan 命令打开一个新的 issue,并自动预填所有正确的版本:

php artisan make:filament-issue

创建 issue 时,我们需要一个“复现仓库”。请勿链接到你的实际项目。我们需要的是一个全新项目中的“最小化”复现,且不包含任何不必要的代码。这意味着即使你的实际项目是私有/机密的也不受影响,因为我们希望链接到一个独立的、隔离的复现仓库。这样我们就能更快地解决问题。如果没有链接,issue 将自动关闭,不再审核,以节省维护人员的时间,这样才能确保流程对那些努力报告问题的人员公平。 如果你认为复现仓库不适合该问题(这种情况非常罕见),请 @danharrin 并解释原因。“这只是一个简单的问题”并不能成为不创建仓库的借口!需要抢先一步?我们为你提供了一个 Filament 项目模板。

请记住,创建错误报告是希望其他遇到相同问题的人能够与你合作解决问题。不要指望错误报告会自动得到关注,或者其他人会立即修复它。创建错误报告是为了帮助你自己和其他人开始解决问题。

新特性开发

如果你想为 Filament 提出新功能或改进建议,你可以使用 GitHub 上托管的讨论论坛。如果你打算通过拉取请求自行实现该功能,我们建议你事先在功能讨论中联系 @danharrin (Filament 的核心维护者),并询问该功能是否适用于该框架,以免浪费你的时间。

插件开发

如果你想开发 Filament 插件,请参阅文档中的插件开发部分。我们的 Discord 服务器也是一个提问和获取插件开发帮助的好地方。你可以在 #plugin-developers-chat 频道发起对话。

你还可以提交你的插件,以便在 Filament 网站上进行推广

使用本地 Filament 副本开发

如果你想要给 Filament 包做出贡献,那么你可能想用一个真正的 Laravel 项目来测试它:

  • Fork GitHub 仓库 到你的 Github 账号。
  • 本地创建一个 Laravel 应用。
  • 克隆你的 Fork 到你的 Laravel 应用的根目录。
  • /filament 目录下创建一个分支,用于你的修复,例如 fix/error-message

在应用的 composer.json 安装该包:

{
    // ...
    "require": {
        "filament/filament": "*",
    },
    "minimum-stability": "dev",
    "repositories": [
        {
            "type": "path",
            "url": "filament/packages/*"
        }
    ],
    // ...
}

现在,请运行 composer update

完成修改后,请提交更改并提交拉取请求到 GitHub 仓库

过期翻译检查

要检查是否有过时的翻译,你可以使用我们的翻译工具。克隆 Filament 仓库,安装命令的依赖项,然后运行该命令。

# Clone
git clone git@github.com:filamentphp/filament.git

# Install dependencies
composer install

# Run the tool  
./bin/translation-tool.php

首先选择 “List outdated translation” 命令,然后选择要检查的语言设置。此命令将显示指定语言设置中缺少哪些翻译。然后,你可以将缺少的翻译提交到 GitHub 仓库

安全漏洞

如果你发现 Filament 存在安全漏洞,请通过 GitHub 提交报告。所有安全漏洞都将得到及时解决。请参阅我们的版本支持政策,了解哪些版本目前正在维护中。

行为准则

请注意,Filament 发布时附带贡献者行为准则。参与此项目即表示你同意遵守其条款。

Edit on GitHub

Still need help? Join our Discord community or open a GitHub discussion

Previous
版本支持策略