Corners
Width
Accent
Headings
Body text
Dark theme
White theme
Mordhau Guides 1.0.0 уже доступна — руководства стабильны, а исправления всегда приветствуются.
Здесь нет ничего сложного.В основном это список вещей, которые избавляют людей, просматривающих ваш запрос на включение, от необходимости спрашивать.
Напишите для тех, кто никогда не делал этого раньше. Причина существования этого проекта в том, что существующая документация Mordhau предполагает, что вы уже знаете ответ.Если для шага требуется предварительное условие, так и скажите.
Будьте конкретны. «Редактировать файл конфигурации» бесполезно.«Открыть Mordhau/Saved/Config/LinuxServer/Game.ini».
Скажите, если вы не уверены. Примечание о том, что значение не проверено, гораздо лучше, чем уверенное неправильное число.Кто-нибудь придет и подтвердит это.
Сохраните существующую структуру. Если в разделе уже есть шаблон, следуйте ему, а не придумывайте новый на своей странице.
Проверьте то, что вы пишете.Если вы документируете команду, запустите ее.Если вы документируете ключ конфигурации, поместите его в настоящий Game.ini и запустите сервер.
Если вы получили информацию откуда-то еще — с другого сайта, из сообщения Discord, из базы знаний хостинг-провайдера — дайте ссылку.И для того, чтобы читатели могли копнуть глубже, и для того, чтобы следующий человек мог сказать, насколько это устарело.
Обновления игры нарушают документацию.Если вы заметили страницу с описанием чего-то, что больше не соответствует игре, исправление этого засчитывается как вклад.
Сохраняйте один запрос на включение в одну тему.Пиар, который исправляет опечатку, а также переписывает страницу RCON, трудно просмотреть и отменить.
Дайте ему название, в котором будет указано, что изменилось.«Обновление» ничего не говорит рецензенту.
Запустите сайт локально перед отправкой:
npm run docs:devУбедитесь, что ваша страница отображается, ваши ссылки идут туда, куда вы думаете, и ничего больше не сломалось.
Если в ходе проверки возвращаются запросы на изменение, это не является отклонением.Отправьте еще один коммит в ту же ветку, и запрос на включение обновится сам.
Ведите себя вежливо.Люди здесь — волонтеры, которые в свободное время пишут документацию для игры, причем зачастую на неродном языке.Исправляйте содержание, а не человека.
Вы сохраняете авторские права на то, что пишете.Внося свой вклад, вы лицензируете его для этого проекта и для всех остальных под номером CC BY-SA 4.0, и ваша заслуга записывается в историю коммитов.
Не публикуйте ничего, на публикацию чего вы не имеете права.