CONTRIBUTING.md

Внесение правок

Введение

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

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

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

Пожалуйста, не используйте систему отслеживания проблем для вопросов не связанных с исходным кодом и/или контентом TulpaWiki. Проверьте, может ли сервер в Discord или группа в Telegram помочь с вашей проблемой.

Ключевые правила

• Каждое принятое изменение обязано обеспечиваться успешной сборкой проекта. Ваши изменения не должны приводить к поломке уже существующей кодовой базы;
• Создавайте issue для любых существенных изменений. Прозрачно обсуждайте вопросы и отвечайте на обратную связь сообщества;
• Не добавляйте блоки, стили, скрипты, файлы и иные изменения в кодовую базу, если они абсолютно не нужны;
• Придерживайтесь единого стиля в коде и контенте;

Ваш первый вклад

Не знаете с чего начать? Обратитесь к списку открытых issues помеченных ярлыками:

• help wanted - задачи, которые могут быть немного сложнее чем задачи для новичков;
• change::minor - запросы на небольшие (менее 64-х строк) изменения, которые могут быть проверены любым желающим;

Количество комментариев является не идеальным, но разумным показателем воздействия, которые окажут описанные изменения.

Быстрый старт

Большие изменения

Для чего-то, что требует больше одного-двух строк изменений:

• Создайте собственный форк (Fork) проекта;
• Внесите необходимые изменения в ваш форк;
• Откройте Merge Request вашего форка в ветку master оригинального репозитория;

Маленькие изменения

Небольшие изменения, вроде исправления опечаток или форматирования, которые достаточно малы чтобы не влиять на общую стабильность проекта, могут быть приняты как патч без дополнительных проверок.

Как правило, изменения являются очевидными исправлениями, если они не привносят никакой новой функциональности или творческого мышления. Пока эти изменения не влияют на функциональность, некоторые примеры могут включать следующее:

• Исправление орфографии / грамматики;
• Исправления опечаток, пробелов и форматирования;
• Удаление комментариев;
• Исправления возвращаемых значений или коды ошибок в константах;
• Внедрение логирования или отладочной информации;
• Изменения метаданных, вроде .gitignore, сборочных скриптов, заголовков контента и так далее;
• Перемещение файлов из одного каталога в другой;

Как сообщить об ошибке

Любые вопросы безопасности должны быть отправлены в виде электронных писем на [email protected]. В случае если вы не уверены в том, связана ли ваша проблема с безопасностью, задайте себе следующие два вопроса:

• Могу ли я получить доступ к чему-либо, что мне не принадлежит или к тому, к чему у меня не должно быть доступа?
• Могу ли я отключить/сломать что-либо для других людей?

Если ответ на оба этих вопроса утвердительный, то вы имеете дело с проблемой безопасности. Помните, что даже в случае отрицательного ответа на оба этих вопроса вы всё ещё можете иметь дело с проблемой безопасности, так что, даже если вы сомневаетесь, просто отправьте письмо на [email protected].

Для гарантии защиты вашего письма от доступа третьих лиц вы можете дополнительно зашифровать его содержимое публичным GPG-ключом.

Публикуя обычное сообщение об ошибке, пожалуйста, укажите следующее:

1. Опишите проблему в целом, используя не более 5 предложений;
2. Опишите шаги для воспроизведения проблемы;
3. Опишите какой результат вы ожидали;
4. Опишите какой результат вы получили;
5. Дополните описание информацией об вашей ОС, браузере, версии компилятора hugo если это применимо;

Скриншоты, видео, GIF и иные, наглядно демонстрирующие ошибку, медиа только приветствуются!

Как предложить улучшение

Философия TulpaWiki заключается в простом и доступном предоставлении информации о тульповодстве/тульпофорсинге в одном месте из сотен-тысяч различных источников. TulpaWiki не развлекательный ресурс или агрегатор, а библиотека и площадка для исследований феномена.

Если вы обнаружили, что нуждаетесь в чём-то, чего нет в TulpaWiki, то, вероятно, вы не одиноки. Возможно, у других пользователей имеются аналогичные потребности в том, в чём нуждаетесь вы. Многие вещи, которые есть в TulpaWiki уже сегодня, были добавлены, потому что пользователи увидели в них необходимость. Откройте issue в соответствующем разделе на GitLab, в котором будет подробно описано что вы хотели бы увидеть, насколько оно важно, зачем оно нужно и как оно должно работать.

Процесс проверки изменений

Всем желающим предложить свои изменения требуется сделать три шага:

• Форкнуть (Fork) репозиторий и внести желаемые изменения;
• Открыть запрос на слияние вашего форка с веткой master оригинального репозитория;
• Пройти проверку владельцев и кураторов оригинального репозитория;

В первую очередь, рассматриваются исправления ошибок, затем - улучшения. Их приоритет определяется через таблицу Эйзенхауэра.

Требования

Вне зависимости от размера и типа изменений они должны соответствовать следующим условиям:

• Ваш форк должен указывать в ветку master;
• Ваш форк должен успешно компилироваться без ошибок ("зелёный тест");
• Ваш код должен соответствовать рекомендациям стиля кода;

Процесс

Когда вы откроете запрос на изменения, владелец и одобренные участники репозитория проверят ваш код и оставят отзыв, если у них возникнут вопросы и/или замечания. Процесс заключается в следующем:

• Вам необходимо разрешить все дискуссии, если они имеют место быть;
• Вам требуется набрать как минимум одно одобрение 👍 от сопровождающих репозитория;
• Ваш код будет включён в кодовую базу ветки master;

Запрос может быть отменён или закрыт если он не обновлялся более двух недель.

Политика очевидных исправлений

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

Сообщество

Если у вас есть вопросы или вы просто хотите пообщаться с другими участниками сообщества, то проверьте следующие ссылки:

• Discord
• Telegram