Краткое содержание
В этой документации описывается, как оформить запрос на новую функцию в Discourse: пошаговое руководство.
Шаг 1: Перед началом
У вас есть отличная идея для новой функции в Discourse? Это замечательно! Вот как вы можете эффективно поделиться ею с командой и сообществом. Перед подачей запроса на новую функцию пожалуйста, потратьте немного времени на поиск существующих обсуждений, чтобы убедиться, что ваша идея уже не была предложена или реализована. Это можно сделать несколькими способами:
- Поиск в категории Contribute > Feature
- Нажав на иконку
в правом верхнем углу страницы, чтобы открыть поиск. Вы можете использовать расширенные фильтры для поиска по категории и тегу. - Просмотр тем с тегами pr-welcome - PR (pull request) — это запрос на слияние в GitHub, способ разработчиков добавлять новый код в проект.
- Просмотр тем с тегом completed
- Поиск в категориях Customization > Plugin и Customization > Theme component
Если ваше предложение уже указано в списке, вы можете поддержать его, проголосовав за него, чтобы повысить его видимость, поставить «нравится» и ответить своими идеями или примерами использования, чтобы дополнительно продемонстрировать его полезность и обосновать необходимость добавления функции.
Не нашли упоминаний о своей идее? Вы можете создать запрос на новую функцию.
Шаг 2: Основные моменты
Заголовок
Важно, чтобы заголовки тем были информативными, но в то же время не слишком длинными. Сфера действия запроса должна быть легко определяема с первого взгляда.
Категория
При создании новой темы выберите категорию Contribute > Feature.
Тег
Теги используются для группировки и классификации функций, поэтому, чтобы запросы оставались организованными, правильная маркировка вашей темы очень полезна для отслеживания. Например, всё, что связано с плагином chat, сохраняется под одним тегом.
Шаг 3: Написание запроса
Написание хорошего запроса на новую функцию важно, так как это помогает команде Discourse быстро определить области, которые могут нуждаться в улучшении.
Помните, создавая запрос на новую функцию, вы пытаетесь представить свою идею и убедить людей в том, что ваша идея обоснована. Объясните, почему вы хотите, чтобы ваша функция была добавлена: для сообщества, для себя и для Команды.
В теле вашей темы кратко изложите запрашиваемую функцию. Будьте конкретны и описательны, избегайте неопределенности и открытости формулировок.
Предоставьте контекст и объяснение
Предоставьте контекст и объяснение для вашего запроса на новую функцию.
- Четкое описание запрашиваемой функции
- Укажите проблему или варианты использования, с которыми вы сталкиваетесь, и то, как ваша функция может это решить
- Любая соответствующая справочная информация или исследования, которые вы провели
Предоставьте примеры и скриншоты (необязательно)
Если это уместно, предоставьте примеры, макеты или скриншоты, чтобы помочь проиллюстрировать ваш запрос на новую функцию, чтобы другие могли легко представить вашу идею.
Взаимодействуйте с сообществом
После создания запроса на новую функцию общайтесь с участниками, отвечая на вопросы и отзывы. Это повысит шансы того, что ваш запрос будет рассмотрен.
Чего ожидать дальше
После подачи вашего запроса на новую функцию он будет рассмотрен сообществом и командой Discourse. Вы можете ожидать:
- Обратную связь и обсуждение со стороны сообщества
- Ответ от сотрудников Discourse, указывающий, является ли ваш запрос выполнимым и находится ли он на рассмотрении
- Возможную реализацию вашей функции в будущем обновлении
Хотите убедиться, что ваша функция будет реализована?
В некоторых случаях запросы на новые функции могут не подходить для ядра системы. Вы можете прочитать, как принимаются решения о функциях. Если вы не можете разработать функцию самостоятельно, есть способы увеличить шансы на её реализацию.
Станьте клиентом discourse.org
Если вы хотите профинансировать разработку, размещая свои сайты у нас, — мы всегда отдаем приоритет запросам клиентов в нашем графике разработки — это один из способов получить реализацию быстрее. Корпоративные клиенты могут запрашивать индивидуальные функции (обычно в виде плагина) от команды ядра системы за почасовую оплату.
Спонсируйте задачу «pr-welcome»
У нас есть исчерпывающий список тем pr-welcome. Это задачи, которые мы хотели бы видеть выполненными, но в настоящее время не имеем ресурсов для их самостоятельной реализации. Спонсирование кого-либо для работы над этими задачами — отличный способ вовлечься в процесс, и любой вклад в Discourse высоко ценится.
Предложите оплачиваемую работу на Маркетплейсе
Если вам нужен плагин, критически важный для вашего бизнеса, разместите объявление об оплачиваемом задании в категории Marketplace. Предоставьте как можно больше деталей, включая скриншоты и бюджет. Вы также можете найти фрилансеров, предлагающих стандартизированные микросервисы, такие как «разовая установка» или «индивидуальная тема».
Общие рекомендации
Общие рекомендации и запреты
Рекомендуется
- Держите свой запрос кратким и сосредоточенным на одной функции
- Избегайте предположений о реализации или технических деталях
- Показывайте готовность к компромиссам и адаптации вашей идеи на основе отзывов сообщества
Не рекомендуется
- Включать более одной функции в одну тему
- Оставлять других в неведении относительно масштаба вашего запроса
Часто задаваемые вопросы
В: Что делать, если у меня нет времени создавать подробный запрос на новую функцию?
О: Если в данный момент вы не можете создать подробный запрос, подумайте над тем, что хотите сказать, и попробуйте позже. Это обеспечит представление вашего лучшего аргумента, что повысит шансы на поддержку вашего запроса другими участниками и его реализацию.
В: Где следует публиковать мой запрос на новую функцию?
О: Используйте соответствующую категорию — запросы на новые функции должны публиковаться в категории #feature::category.
В: Что делать, если я не уверен, какой тег использовать для моего запроса?
О: Хотя теги соответствуют названиям плагинов и компонентов тем для удобства использования, член Команды или Regular добавит подходящий тег к вашей теме, если он оставлен пустым.
Будьте уважительны и открыты к новому в своем запросе. Избегайте использования запроса на новую функцию для выражения разочарования. Любое неподобающее поведение или язык могут привести к задержке или игнорированию вашего запроса.
Дополнительные ресурсы
- Категории: Contribute > Feature, Marketplace, Customization > Plugin, Customization > Extras, Customization > Theme, Customization > 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
