Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update preparing code for contributors #199

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update preparing code for contributors #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/en/community/contributors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
39 changes: 26 additions & 13 deletions docs/ru/community/contributors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
````


## Отладка и отправка запроса на изменение


Expand Down Expand Up @@ -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
```

### Отправка запроса на изменение

Создайте новую ветку например так:
Expand Down