Пролог

Руководство по внесению вклада

Как мы можем помочь?

Сообществу нужны активные пользователи. Вы можете помочь многими способами:

  • Сообщать об ошибках,
  • Дополнять код,
  • Разрабатывать фронтенд,
  • Помогать другим пользователям,
  • Дополнять документацию,
  • Продвигать проект.

Что мы используем

  • Blade,
  • TailwindCSS,
  • AlpineJs.

С чего начать?

Существует уже функциональный продукт, который полностью работоспособен и тестируем. Функциональный не значит идеальный, поэтому наша задача - сделать его лучше.

Pull requests

Вы можете предлагать новые функции или улучшения для MoonShine! Ошибки и баги - всё это можно исправить и отправить на доработку. Мы также рады новым специалистам для разработки проекта с открытым исходным кодом.

Где обсуждать разработку?

Для активных участников проекта создан отдельный чат в телеграме. Если вы готовы принять участие в разработке, то присоединяйтесь - MoonShine.

Если вы нашли ошибку

  1. У вас достаточно опыта, чтобы предложить решение. Я буду крайне рад вашему PR с описанием ошибки и вариантом её исправления.
  2. Если вы не знаете, как решить проблему - создайте GitHub issues, и мы скоро исправим проблему.

Важно, чтобы ваш PR прошел все тесты платформы и имел подробное описание, чтобы всем участникам разработки было понятно, что именно произошло.

Основная ветка

На данный момент основная ветка 3.x.

Стиль кодирования

MoonShine придерживается стандарта PSR-12 и стандарта автозагрузки PSR-4.

Инструкции для разработчиков

  1. Создайте директорию для проекта и клонируйте демо.
git clone git@github.com:moonshine-software/demo-project.git .
  1. Добавьте директорию packages и выполните команду ниже.
cd packages && git clone git@github.com:moonshine-software/moonshine.git && cd moonshine && composer install && npm install
  1. Вернитесь в директорию проекта и в composer.json измените зависимость moonshine/moonshine.
"moonshine/moonshine": "3.*.*-dev",
  1. Добавьте в composer.json.
"repositories": [
    {
        "type": "path",
        "url": "packages/moonshine",
        "options": {
            "versions": {
                "moonshine/moonshine": "3.*.*-dev"
            },
            "symlink": true
        }
    }
]
  1. Создайте .env из .env.example (не забудьте создать базу данных) и выполните установку ниже.
php artisan key:generate
php artisan storage:link
php artisan migrate --seed
php artisan moonshine:user
php artisan serve

Создавайте что-нибудь полезное!

Как сделать pull request?

  • Перейдите в репозиторий MoonShine и нажмите на "Fork",
  • Сделайте git clone вашего форка,
  • Создайте новую ветку для ваших изменений,
  • Делайте коммиты, опираясь на конвенцию https://www.conventionalcommits.org,
  • Сделайте push ваших изменений в ваш форк,
  • Снова перейдите в репозиторий MoonShine и нажмите "New pull request",
  • Подробно прокомментируйте внесенные изменения в поле "Description",
  • Ожидайте ревью!

Есть вопросы?

Меня зовут Данил! Пишите мне на почту thecutcode@gmail.com.