From 7c8349f506c9084fabd7bd13680b39418f329b9a Mon Sep 17 00:00:00 2001 From: Mikhail Salkov Date: Tue, 23 Jan 2024 17:40:34 +0500 Subject: [PATCH] Update preparing code for contributors --- docs/en/community/contributors.md | 6 +++-- docs/ru/community/contributors.md | 39 ++++++++++++++++++++----------- 2 files changed, 30 insertions(+), 15 deletions(-) diff --git a/docs/en/community/contributors.md b/docs/en/community/contributors.md index d2c9488a7..cb2e1e135 100644 --- a/docs/en/community/contributors.md +++ b/docs/en/community/contributors.md @@ -69,9 +69,11 @@ npm run dev --prefix platform && php artisan orchid:publish ### Preparing code for submitting -First you need to check the code style ([Laravel Pint](https://laravel.com/docs/10.x/pint) is used for this) +ORCHID follows [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide-meta.md) and [PSR-4](Https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md) standards. -Run check and fix: +First you need to check the code style ([Laravel Pint](https://laravel.com/docs/10.x/pint) is used for this). + +Run check and fix: ```bash ./vendor/bin/pint diff --git a/docs/ru/community/contributors.md b/docs/ru/community/contributors.md index 486ab5cdb..ac85ef396 100644 --- a/docs/ru/community/contributors.md +++ b/docs/ru/community/contributors.md @@ -37,19 +37,6 @@ description: Я призываю всех внести свой вклад в п Все обращения будут незамедлительно рассмотрены. -## Стиль написания кода - -ORCHID следует [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide-meta.md) и [PSR-4](Https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md) стандартам. - - -Вы можете использовать [PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer), чтобы исправить свой стиль кода перед публикацией. - -Чтобы приступить к работе, установите инструмент на глобальном уровне и проверьте стиль кода, выполнив следующую команду из терминала корневой директории вашего проекта: -````bash -php-cs-fixer fix -```` - - ## Отладка и отправка запроса на изменение @@ -89,6 +76,32 @@ composer require orchid/platform:@dev Composer поставит пакет из хранилища который вы указали. Остальные действия соответствуют разделу `Установки`. +### Подготовка кода к отправке + +ORCHID следует [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide-meta.md) и [PSR-4](Https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md) стандартам. + +Для начала нужно проверить стиль кода (для этого используется [Laravel Pint](https://laravel.com/docs/10.x/pint)). + +Запустить проверку и исправление стиля кода: + +```bash +./vendor/bin/pint +``` + +Проверка произвольных файлов или папок: + +```bash +./vendor/bin/pint src/Platform + +./vendor/bin/pint src/Platform/Dashboard.php +``` + +Далее необходимо проверить выполнение unit тестов: + +```bash +./vendor/bin/phpunit +``` + ### Отправка запроса на изменение Создайте новую ветку например так: