Качественная документация — это основа любого успешного проекта. Она помогает новым разработчикам быстрее разобраться с функционалом, а опытным — избежать ошибок. Совместная работа над документацией поможет сделать MoonShine лучше!
Если вы обнаружили ошибку или неточность в документации MoonShine, вы можете (и даже обязаны, если считаете себя true-девелопером) предложить исправление через Pull Request (PR). В этой статье я подробно расскажу, как это сделать. Займёт несколько минут, а вы получите полезный навык создания Pull Request.
Шаг 1: Находим ошибку
Итак, допустим, вы нашли ошибку, и вы решили её исправить.
Листаем в самый конец документа и нажимаем кнопку Нашли ошибку? Помогите исправить.
Шаг 2: Авторизация и форк
Авторизуемся в GitHub (если это необходимо) и жмем кнопку Fork this Repository, чтобы создать копию репозитория в своем аккаунте.
Шаг 3: Делаем Commit
Переходим в форкнутый репозиторий и вносим необходимые исправления в нужном месте. После завершения изменений нажимаем Commit changes.
Важно: указывайте осмысленное описание (Extended description), которое поможет другим разработчикам понять, что именно вы исправили.
Шаг 4: Проверяем изменения
Перед тем как отправить изменения (сделать Pull Request), убедитесь, что все исправления корректны и не содержат новых ошибок. Проверьте, что ваш код или текст соответствуют стандартам проекта.
Шаг 5: Создаем Pull Request (PR)
После проверки жмем Create Pull Request. В описании PR обязательно укажите, что исправление относится к русской версии документации, отметив галочкой пункт [x] Ru.
Шаг 6: Проверяем Pull Request
После создания PR проверьте, что он корректно отображается в списке Pull Requests репозитория с документацией MoonShine. Убедитесь, что все изменения соответствуют ожиданиям и не конфликтуют с основной веткой. Если необходимо, добавьте дополнительные комментарии или пояснения.
Заключение
Следуя этому небольшому гайду, вы сможете внести вклад в развитие MoonShine и дополнить документацию. Более подробное описание, исправления ошибок, добавление информации в документацию MoonShine отличная помощь и это и есть настоящий Open Source - совместная работа над проектом.
Помните, что качественные описания и внимательная проверка изменений — залог успешного Pull Request. Удачи в разработке! 🚀
Если у вас остались вопросы или что-то непонятно, не стесняйтесь задавать их в чате по MoonShine - https://t.me/moonshine_ru . Сообщество MoonShine всегда готово помочь!