Участвовать в развитии

MineAdmin — это проект с открытым исходным кодом, и мы приветствуем участие любого желающего в его развитии. Если вы хотите принять участие в разработке, пожалуйста, прочтите следующее.

Адрес репозитория

В настоящее время основной репозиторий исходного кода размещен на GitHub, а репозиторий исходного кода фронтенда и бэкенда в репозитории gitee используется как зеркальный репозиторий. Код автоматически синхронизируется каждый день. Мы не поддерживаем никаких видов отправки кода. Однако документация поддерживается в репозитории кода.

GitHub

• Исходный код бэкенда MineAdmin
• Исходный код фронтенда MineAdmin
• Компоненты ядра MineAdmin

Gitee

• Документация MineAdmin
• Исходный код бэкенда MineAdmin
• Исходный код фронтенда MineAdmin

Чем вы можете помочь

Отслеживание задач* Мы будем выпускать некоторые ожидаемые функции в задачах. Если вас заинтересует, вы можете оставить комментарий в задачах, мы ответим вам как можно скорее.

• Ответы на комментарии помогают пользователям, задающим вопросы;
• По содержанию задач, предлагайте разумное решение; переходите к исправлению ошибок или реализации функций, и отправьте пулл-запрос в репозиторий MineAdmin.
• Обращайте внимание на ход и статус своих пулл-запросов, чтобы как можно быстрее продвигать свои пулл-запросы к слиянию в основной репозиторий;
• Выполняйте проверку кода других пулл-запросов и давайте ваши предложения и мнения.
• Разрабатывайте независимые функциональные компоненты на основе требований других людей или ваших собственных;
• Улучшайте документацию, чтобы предоставлять лучшие инструкции по использованию.### Правила для пулл-запросов

Хотя мы регулярно выпускаем новые функции для развития, вы всегда можете предложить те функции, которые бы хотели реализовать. Вы можете отправить свои идеи в issues, и мы ответим как можно скорее, сообщив, приняты они или нет.

Перед тем как создать issue, пожалуйста, проверьте, не было ли уже создано что-то подобное.

• Создайте форк этого репозитория в вашем аккаунте на GitHub;
• Формат сообщения коммита должен быть [Имя файла]: Информация о коммите. Например, README.md: Устранение xxx ошибок;
• Выполните команду composer cs-fix, чтобы отформатировать ваш код перед тем как сделать коммит;
• Выполните команду composer an для статического анализа кода перед тем как сделать коммит;
• Выполните команду composer test перед отправкой кода;
• Убедитесь, что вы создаёте запрос на слияние (PR) с вашего функционального ветвления, а не делаете изменения непосредственно в основной ветке (master);
• Если ваш запрос на слияние исправляет ошибку, пожалуйста, предоставьте описание этой ошибки.

Ниже приведены инструкции на русском языке

Внесение вклада

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

На данный момент исходный код хранится на GitHub, а также есть зеркальные репозитории на Gitee для backend и frontend кода. Каждый день происходит автоматическая синхронизация кода. Любые формы коммитов недопустимы. Однако документация находится под управлением в Gitee репозитории.

GitHub

• Backend исходный код MineAdmin
• Frontend исходный код MineAdmin
• Компоненты ядра MineAdmin

Gitee

• Документация MineAdmin
• Backend исходный код MineAdmin
• Frontend исходный код MineAdmin

Что вы можете сделать

Обратите внимание на issues* Мы будем публиковать некоторые функции, требующие разработки, в разделе issues. Если вас заинтересует одна из этих функций, вы можете оставить свой отзыв в этом разделе, и мы ответим вам как можно скорее.

• Отвечайте на вопросы пользователей, которые оставили свои отзывы;
• Предлагайте рациональные решения на основе содержания issues; исправляйте ошибки или реализовывайте функции, и представляйте их в виде pull request в репозиторий MineAdmin;
• Отслеживайте прогресс и состояние своих pull requests, чтобы ускорить их включение в основной репозиторий;
• Анализируйте pull requests других участников и предлагайте свои рекомендации и мнения;
• Разрабатывайте независимые компоненты в соответствии с потребностями других участников или ваших собственных;
• Улучшайте документацию, предоставляя лучшие руководства по использованию.

Инструкция по созданию pull requestХотя мы регулярно выпускаем новые функции, мы также рады, если вы сами предложите свои идеи. Вы можете высказать свою идею в разделе issues, и мы как можно скорее ответим, будет ли она принята. Перед тем как отправить запрос, проверьте, нет ли уже аналогичной проблемы.

• Создайте форк этого репозитория на вашем аккаунте GitHub;
• Формат сообщения о коммите должен быть следующим: [Название файла]: Описание коммита. Например, README.md: Устранение ошибки xxx;
• Перед отправкой кода выполните команду composer cs-fix для форматирования кода;
• Перед отправкой кода выполните команду composer an для статического анализа кода;
• Перед отправкой кода выполните команду composer test для запуска юнит-тестов; юнит-тесты не следует запускать на рабочей среде, так как они могут удалить тестовые данные;
• Убедитесь, что ваш pull request создан с вашего ветвления функций, а не непосредственно на ветке master;
• Если ваш pull request исправляет ошибку, предоставьте описание связанной ошибки.