Как составить proposal?
-
Сделайте копию шаблона design proposal, находящегося в
src/en/templates/proposal.md. - Ознакомьтесь с Core Design Documentation SS14 (для proposal, связанных с геймплеем).
- Напишите ваш proposal (см. руководство по редактированию документации).
- Когда ваш proposal будет готов к рассмотрению, создайте pull request.
-
Ваш proposal утверждён, когда maintainer выполняет его merge. Это зелёный свет для вас или кого-то ещё, чтобы реализовать его. Maintainer затем добавит ссылку на ваш proposal в боковую панель. Примечание для maintainer: отредактируйте
src/SUMMARY.md
tip
Нет, что такое design doc?
Design document — это краткое описание высокого уровня того, что вы предлагаете добавить в игру. По сути, они служат для того, чтобы зафиксировать нечёткие идеи на бумаге, чтобы было легче понять, как именно эти идеи будут сочетаться с остальным проектом. Обычно они состоят из нескольких частей.- Зачем предлагается данная функция — может быть как просто «я думаю, это было бы круто», так и более конкретно, например «я заметил проблемы ABC в геймплейном цикле Cargo и хочу добавить XYZ для их решения».
- Краткое описание того, что представляет собой функция, как она взаимодействует с игроками и как взаимодействует с другими крупными частями игры.
- Более детальное описание предлагаемой механики функции, того, как игроки будут с ней взаимодействовать и как эта механика связана с другими частями игры. Не нужно вдаваться в каждую конкретную деталь; достаточно сказать, что должны быть химикаты, выполняющие определённые роли, не описывая точные химикаты.
warning
Действительно ли моей идее нужен design doc?
Это зависит от масштаба и распространённости того, что вы предлагаете. Если это что-то вроде добавления одного оружия или пары простых растений — вероятно, нет. С другой стороны, если вы добавляете целый подотдел вроде аномалий/ксеноархеологии или нечто масштабное, как переработка целой ботаники или химии — то да. Хорошее эмпирическое правило: если новая функция или переработка, которую вы задумали, потребует добавления или переработки страницы guidebook или одного из feature docs на этом сайте, то, вероятно, нужен design doc. То же самое, если proposal можно точно описать как «переработка всего X».Будет ли мой design doc принят?
Понятия не имею! То, что принимается, а что нет, определяется одобрением maintainer, как и обычные PR. Если вам удастся убедить хотя бы одного maint, что это звучит как хорошая идея, есть большая вероятность, что он будет принят. Практически любая идея потребует хотя бы некоторой критики, прежде чем будет смержена, так что не расстраивайтесь!tip