Краткое содержание
Данная тема документации посвящена тому, как оформить запрос на новую функцию в Discourse: пошаговое руководство.
Шаг 1: Перед началом
Итак, у вас есть отличная идея для новой функции в Discourse? Это замечательно! Вот как вы можете эффективно поделиться ею с командой и сообществом. Прежде чем отправлять запрос на новую функцию, пожалуйста, уделите минуту и поищите существующие обсуждения, чтобы убедиться, что ваша идея ещё не была предложена или реализована. Сделать это можно несколькими способами:
- Просмотр категории #feature
- Нажатие на иконку
в правом верхнем углу страницы, чтобы открыть поиск. Вы можете использовать расширенные фильтры для сортировки по категории и тегу. - Просмотр тем с тегом pr-welcome — PR (pull request) — это запрос на слияние в GitHub, способ для разработчиков внести новый код в проект.
- Просмотр тем с тегом completed
- Просмотр категорий #plugin и #theme-component
Если ваше предложение по функции уже есть в списке, вы можете поддержать его, проголосовав за него, чтобы сделать запрос более заметным, поставив лайк, а также ответив с дополнительными идеями или вариантами использования, чтобы ещё раз подчеркнуть полезность функции и объяснить, почему её стоит добавить.
Не нашли упоминания вашей идеи? Тогда вы можете создать запрос на новую функцию.
Шаг 2: Основы
Заголовок
Важно, чтобы заголовки тем были информативными, но при этом не слишком длинными. Область применения запроса должна быть легко узнаваема с первого взгляда.
Категория
При создании новой темы, пожалуйста, выберите категорию #feature.
Тег
Теги используются для группировки и классификации функций, поэтому для поддержания порядка в запросах правильная разметка темы тегами очень полезна для отслеживания. Например, всё, что связано с плагином chat, объединено под одним тегом.
Шаг 3: Написание вашего запроса
Качественное оформление запроса на новую функцию важно, так как это помогает команде Discourse быстро выявить области, требующие улучшения.
Помните: создавая запрос на новую функцию, вы пытаетесь презентовать свою идею и убедить людей в том, что ваше предложение хорошо обосновано. Объясните, почему вы хотите, чтобы ваша функция была добавлена: сообществу, вам самим и команде.
В теле темы кратко изложите запрашиваемую функцию. Будьте конкретны и описательны, избегайте неопределённости или слишком широких формулировок.
Предоставьте контекст и объяснение
Дайте контекст и объяснение для вашего запроса на новую функцию.
- Чёткое описание запрашиваемой функции
- Укажите проблему или варианты использования вашей текущей ситуации и то, как ваша функция поможет её решить
- Любую релевантную фоновую информацию или проведённые вами исследования
Приведите примеры и скриншоты (необязательно)
Если это применимо, приведите примеры, макеты или скриншоты, чтобы проиллюстрировать ваш запрос на новую функцию, чтобы другие могли легко представить вашу идею.
Взаимодействуйте с сообществом
После создания запроса на новую функцию взаимодействуйте с участниками, отвечая на вопросы и получая обратную связь. Это повысит шансы на рассмотрение вашего запроса.
Чего ожидать дальше
После отправки запроса на новую функцию он будет рассмотрен сообществом и командой Discourse. Вы можете ожидать:
- Обратную связь и обсуждение от сообщества
- Ответ от сотрудников Discourse о том, осуществим ли ваш запрос и рассматривается ли он
- Возможную реализацию вашего запроса в одном из будущих обновлений
Хотите убедиться, что ваша функция будет реализована?
В некоторых случаях запросы на новые функции могут не подходить для ядра проекта. Вы можете узнать, как принимаются решения о функциях. Если вы не можете разработать функцию самостоятельно, всё ещё есть способы увеличить шансы на её реализацию.
Станьте клиентом discourse.org
Если вы хотите финансировать разработку, размещая сайты у нас — мы всегда приоритизируем запросы клиентов в нашем плане разработки — это один из способов ускорить процесс. Корпоративные клиенты могут заказывать кастомные функции (обычно в виде плагинов) у основной команды почасово.
Спонсируйте задачу с меткой «pr-welcome»
У нас есть полный список тем с тегом pr-welcome. Это задачи, которые мы очень хотели бы увидеть завершёнными, но в данный момент не имеем ресурсов для их самостоятельной реализации. Спонсирование работы над такими задачами — отличный способ принять участие, и любой вклад в Discourse высоко ценится.
Предложите платную работу на Marketplace
Если вам нужен плагин, критически важный для вашего бизнеса, разместите объявление о платной задаче в категории Marketplace. Укажите как можно больше деталей, включая скриншоты и бюджет. Вы также можете найти фрилансеров, предлагающих стандартизированные микроуслуги, такие как «разовая установка» или «персонализированная тема».
В целом
Общие правила: что делать и чего избегать
Делайте:
- Держите ваш запрос кратким и сосредоточенным на одной функции
- Избегайте предположений о реализации или технических деталях
- Проявляйте готовность к компромиссам и адаптации вашей идеи на основе обратной связи от сообщества
Не делайте:
- Не включайте более одной функции в одну тему
- Не оставляйте других участников с вопросами о масштабе вашего запроса
Часто задаваемые вопросы (FAQ)
В: Что делать, если у меня нет времени создать подробный запрос на функцию?
О: Если в данный момент вы не можете создать подробный запрос, обдумайте, что вы хотите сказать, и попробуйте позже. Это обеспечит наиболее убедительное изложение вашей позиции, что повысит шансы на поддержку вашего запроса и его реализацию.
В: Где мне разместить запрос на новую функцию?
О: Используйте соответствующую категорию — запросы на новые функции должны размещаться в категории #feature::category.
В: Что делать, если я не уверен, какой тег использовать для моего запроса?
О: Хотя теги часто совпадают с названиями плагинов и компонентов тем для удобства использования, если тег не указан, член команды или постоянный участник добавит соответствующий тег к вашей теме.
Будьте уважительны и открыты в своём запросе. Избегайте использования запроса на новую функцию для выражения разочарования. Любое неуместное поведение или язык могут привести к задержке или игнорированию вашего запроса.
Дополнительные ресурсы
- Категории: #feature, Marketplace, #plugin, #plugin:extras, #theme, #theme-component
- Теги: current-projects, release-notes, pr-welcome, planned
- https://meta.stackexchange.com/questions/258136/how-do-i-write-a-good-feature-request
- How do we decide what goes into each release of Discourse?
- Discourse pricing | Discourse - Civilized Discussion
