Участие в разработке



Я призываю всех внести свой вклад в проект ORCHID. Вы можете найти последнюю версию кода на GitHub по адресу https://github.com/orchidsoftware/platform.

Отслеживание проблем

Вы можете найти нерешенные вопросы на GitHub Issues Tracker. Если вы намерены работать по конкретному вопросу, оставьте комментарий на соответствующий задачу для информирования других участников проекта.

Для активного развития, настоятельно рекомендуется использовать только запросы на добавление изменений (pull requests), а не просто сообщения об ошибках (bug reports).

Если вы создали отчёт об ошибке, то он должен содержать заглавие и чёткое описание проблемы. Вы так же должны включить в него как можно более полную информацию и пример кода, которые помогут воспроизвести проблему. Основная цель отчёта об ошибке – упростить локализацию, воспроизведение проблемы и поиск её решения.

Также помните, что отчёты об ошибках создаются в надежде, что другие пользователи с такими же проблемами смогут принять участие в их решении вместе с вами. Но не ждите, что другие всё бросят и начнут исправлять вашу проблему. Отчёт об ошибке призван помочь вам и другим начать совместную работу над решением проблемы.

Участие в основных обсуждениях

Вы можете предложить новые функции и усовершенствования существующего поведения ORCHID. Если вы предлагаете новую функцию, пожалуйста, будьте готовы выполнять по крайней мере, примеры кода, которые будут необходимы для вызова/использования этой функции.

Неформальное обсуждение по поводу ошибок/проблем и новых возможностей:

  1. Telegram группа @orchid_community
  2. Slack группа ORCHID

Безопасность

Если вы обнаружили уязвимость в безопасности внутри ORCHID, пожалуйста отправьте e-mail сообщение на почту bliz48rus@gmail.com. Все обращения будут незамедлительно рассмотрены.

Стиль написания кода

ORCHID следует PSR-2 и PSR-4 стандартам.

Вы можете использовать PHP-CS-Fixer, чтобы исправить свой стиль кода перед публикацией.

Чтобы приступить к работе, установите инструмент на глобальном уровне и проверьте стиль кода, выполнив следующую команду из терминала корневой директории вашего проекта:

php-cs-fixer fix

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

На этапе помощи проекту могут возникнуть вопросы связанные с отладкой и установки, этот раздел создан для тех кто хочет отправить запрос впервые.

Установка для разработки

Для установки пакета ORCHID в качестве разработчика необходимо поставить фреймворк laravel.

Сперва вы должны сделать fork репозитория на github, что бы иметь возможность отправить изменения.

Перейти в каталог и выполнить:

git clone https://github.com/yourname/platform.git

Добавьте локальный репозиторий в composer.json приложения:

"repositories": [
    {
        "type": "path",
        "url": "./platform"
    }
]

И добавим наш пакет в зависимости:

composer require orchid/platform:@dev

Composer поставит пакет из хранилища который вы указали. Остальные действия соответствуют разделу Установки.

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

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

git checkout -b feature/issue_001

Это позволит почти сразу понимать, что созданная ветка добавляет новый функционал из сообщения под номером 001.

Внесите изменения и зафиксируйте их:

git commit -am 'ref #001 [Docs] Fix misprint'

Для отправки своей ветки требуется выполнить:

git push origin feature/issue_001