贡献者
建议编辑贡献与协作
Orchid 项目依赖于社区协作。我们邀请您参与开放讨论、提出问题和建议想法,欢迎访问我们的 GitHub 讨论区。您的意见可以塑造 Orchid 的未来!
如果您遇到任何错误或有特定的功能请求,请查看我们的 问题跟踪器。您可以找到未解决的问题,并通过在相关任务上留下评论来表明您愿意处理特定问题。
对于活跃的开发,我们鼓励您使用 pull requests
而不仅仅是报告错误。这种协作方法有助于我们高效地解决问题并增强 Orchid。
撰写有效的错误报告
提交错误报告时,提供简明而全面的细节至关重要。为了确保您的报告对开发人员有帮助,请确保他们可以轻松重现问题。请务必包括逐步说明以复制问题。我们恳请您用英语报告错误,同时注意语法和语言使用。
请记住,错误报告旨在鼓励协作,并允许其他有类似问题的用户参与解决方案的寻找。虽然我们感谢您的热情,但需要注意的是,其他人可能无法立即放下手头工作来解决您的特定问题。错误报告是合作解决问题的起点。
安全问题
如果您发现平台中的任何安全漏洞,请立即发送电子邮件至 bliz48rus@gmail.com
。我们非常重视所有安全问题,并会及时处理。
调试和提交更改请求
在为项目做贡献时,您可能会遇到与调试和安装相关的问题。本节旨在帮助您提交您的第一个更改请求。
开发安装
要作为开发人员安装 Laravel Orchid 包,您需要安装 Laravel 框架。
在进行更改之前,fork GitHub 仓库 并创建其克隆。
导航到您新安装的 Laravel 的根目录并执行以下命令:
git clone https://github.com/yourname/platform.git
接下来,在您的 Laravel 项目的 composer.json
文件中添加本地仓库,以将 Orchid 平台指向您本地克隆的 fork:
"repositories": [
{
"type": "path",
"url": "./platform"
}
]
最后,通过执行以下命令来包含我们的包:
composer require orchid/platform:@dev
Composer 将从您指定的仓库中添加包。按照“安装”部分中的其余安装说明进行操作。
要收集 JavaScript 和 CSS 资源并立即应用它们,请使用以下命令:
npm run dev --prefix platform && php artisan orchid:publish
准备代码以提交
首先,您需要检查代码风格(使用 Laravel Pint)
运行检查和修复:
./vendor/bin/pint
在特定文件或目录上运行:
./vendor/bin/pint src/Platform
./vendor/bin/pint src/Platform/Dashboard.php
接下来,您需要检查单元测试的执行:
./vendor/bin/phpunit
提交更改请求
创建一个新分支,指示添加的功能或修复的问题。使用以下命令:
git checkout -b feature/issue_001
此分支名称将表示您正在处理与消息编号 001 相关的特定功能。
进行更改并提交:
git commit -am 'ref #001 [Docs] Fix typo'
要提交您的分支以供审查,请执行以下命令:
git push origin feature/issue_001
帮助将 Orchid 翻译成不同语言!
我们感谢您为将 Orchid 翻译成多种语言所做的贡献。访问讨论选项卡中的 Make Orchid (more) International 对话以获取更多详细信息。翻译文件可以在 resources/lang 目录中找到。
要开始翻译,请按照“开发安装”部分中概述的步骤创建开发安装。为您的翻译创建一个新分支:
git checkout -b feature/translation_nl
从 resources/lang 目录中复制现有的 JSON 文件之一,并根据 ISO_639–1 代码列表 页面中提到的代码命名您的文件。
完成翻译后,请按照之前提到的说明将其作为更改请求提交。
我们感谢您致力于让 Orchid 为更广泛的受众所用。您的翻译将帮助我们接触到世界各地的更多用户。
我们希望这份详细的文档能帮助您有效地贡献并参与 Orchid 的发展。我们珍视您为使 Orchid 更好、更易用所付出的时间和努力。感谢您成为我们社区的一员!