Skip to content

Latest commit

 

History

History
75 lines (44 loc) · 10.4 KB

CONTRIBUTING.md

File metadata and controls

75 lines (44 loc) · 10.4 KB

Информация для тех, кто хочет сделать вклад в вики

Important

Перед тем, как продолжить, полезно прочитать/перечитать LICENSE.md - при успешном прохождении проверки, вы безотзывно соглашаетесь с условиями этой лицензии.

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

Сделать это можно несколькими способами:

1 способ. Классический

Important

Этот способ подразумевает, что вы умеете работать с Git/GitHub Desktop, подробнее о настройке можно прочитать тут и тут

  1. Сделайте форк этого репозитория;
  2. Клонируйте его себе на компьютер (git clone ссылка на ваш форк);
  3. Создайте отдельную ветку и перейдите туда (git checkout -b мояправка);
  4. Сделайте нужные изменения, запишите их (git commit -am "Описание правки") и опубликуйте (git push origin ветка), после чего создайте пулл реквест в нашем репозитории.

Warning

Всегда делайте свои изменения в отдельной ветке с понятным названием (fghfkrhf и прочая длинная белиберда не допускается), делать их в главной (main) - зачастую плохая практика.

2 способ. Быстрое редактирование

Если вы нашли ошибку в одной единственной статье/хотите её расширить - просто откройте нужный файл и нажмите на карандаш справа, в таком случае форк вместе с пулл реквестом создастся автоматически после применения всех изменений.

edit

Также, оставаясь в вики и не заходя в репозиторий для поиска статьи, можно нажать на кнопку "Отредактировать на GitHub и отправить на проверку".

3 способ: на случай если нет возможности воспользоваться всеми остальными способами

Caution

Используйте этот способ только тогда, когда действительно нет возможности воспользоваться всеми остальными (он имеет множество ограничений как и для вас, так и для коллабораторов).

Просто создайте Issue и в описании напишите либо целую статью которую нужно добавить, либо же прочую информацию о новой статье/о ошибках в ней.

issue

Посмотреть, что вы написали можно в Preview:

issue2

После отправки вам необходимо ждать того момента, когда коллабораторы репозитория заметят вашу статью. Будьте готовы к тому, что её могут либо не принять, либо же некоторая часть текста может быть значительно отредактирована по разным причинам (ошибки билда, нарушение энциклопедичности и прочее).

Как не ударить в грязь лицом

Перед отправкой всегда проверяйте, как выглядит статья командой npm run dev, таким образом вы сможете увидеть либо ошибки билда, либо отсутствие форматирования там, где оно необходимо.

Также нужно, чтобы были соблюдены абсолютно все пункты (по возможности, есть и необязательные):

  1. Все пулл реквесты должны направляться в главную ветку, а не в какие-либо другие;

  2. (НЕОБЯЗАТЕЛЬНО, НО ЖЕЛАТЕЛЬНО) При создании пулл реквеста должна стоять галочка "Allow edits by maintainers", в противном случае провести исправление очевидных ошибок/довести запрос до конца на случай вашего исчезновения будет невозможно;

  3. Все ассеты для статей (изображения, видео и прочее), которые находятся не в папке public (на внешних ссылках/других папках) подлежат немедленному переносу туда, куда они должны быть (за вас это никто делать не будет);

  4. Markdown файлы должны проходить проверку линтером, а также статья должна быть заранее просмотрена через npm run dev на предмет явных дефектов, которые могут повлечь ошибки билда (см. Запуск);

Tip

Для полной проверки каталога со статьями (src), в том числе и с техническими файлами (README.md, LICENSE.md, CONTRIBUTING.md и прочие файлы с .md расширением в корневой папке) можно также использовать команду npm run check, а для автоматической попытки исправления ошибок - npm run attemptfix. Также можно использовать npm run fixandcommit, если необходимо не только исправить ошибки, но и записать все изменения (не делайте этого, если у вас имеются прочие незаписанные изменения, команда запишет абсолютно все незаписанные файлы).

  1. (НЕОБЯЗАТЕЛЬНО, НО ЖЕЛАТЕЛЬНО) Отсутствие буквы Ё в тех словах, где она должна быть, считается недостатком оформления статьи (преднамеренная/непреднамеренная замена на Е не возбраняется), и в случае нарушения этого пункта коллабораторы оставляют за собой право на ёфикацию текста;

  2. Статьи не должны содержать грамматических и пунктуационных ошибок. В случае их большого количества ваш запрос будет отклонён;

  3. Статьи, а также ассеты для них (если нет возможности сделать ту или иную фотографию для статьи самому - то разрешается взять с нашего дискорда либо попросить помощи у участников) не должны быть откуда-либо скопированы/скачаны. Лицензия, по которой распространяются материалы, не позволяет сочетать свободное и несвободное (коим зачастую и могут являться скопированные статьи/ассеты) содержимое, а также вики не должна походить на своеобразный "забор плагиата". Все запросы на добавление таких статей будут либо отклоняться, либо же будет удаляться значительная часть текста (если был скопирован только кусок).

Note

Фотографии с Discord сервера, сделанные участниками, находятся в общественном достоянии под CC PDM 1.0 (но такое бывает не всегда, и возможно вы всё равно захотите попросить разрешения на их использование).

Желаем вам удачи!