Contribution Guide

# Чем можно помочь?

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

  • Дополнять код
  • Front-end разработка
  • Отправлять отчёты об ошибках
  • Помогать другим пользователям разобраться в деталях
  • Дополнять документацию
  • Заниматься популяризацией проекта

# Используем

  • Blade
  • TailwindCSS
  • AlpineJs

# С чего мы начнем?

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

# Pull requests

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

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

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

# Если нашли ошибку

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

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

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

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

# Coding style

MoonShine придерживается PSR-12 стандарта и PSR-4 autoload стандарта.

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

1 Создайте директорию для проекта и клонируйте демо.
git clone git@github.com:moonshine-software/demo-project.git .
2 Добавьте директорию packages и выполните команду ниже.
cd packages && git clone git@github.com:moonshine-software/moonshine.git && cd moonshine && composer install && npm install
3 Вернитесь в директорию проекта и в composer.json измените зависимость moonshine/moonshine.
"moonshine/moonshine": "2.*.*-dev",
4 Добавьте в composer.json.
"repositories": [
{
"type": "path",
"url": "packages/moonshine",
"options": {
"versions": {
"moonshine/moonshine": "2.*.*-dev"
},
"symlink": true
}
}
]
5 Создайте .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 вашего fork
  • Создайте новую ветку для ваших изменений
  • Делайте commits, полагаясь на конвенцию https://www.conventionalcommits.org
  • Сделайте push ваших изменений в ваш fork
  • Снова перейдите в репозиторий MoonShine и нажмите "New pull request"
  • Подробно прокомментируйте сделанные изменения в поле "Описание"
  • Ожидайте ревью!

# Возникли вопросы?

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