Перейти к содержимому

Участвовать

Участвовать

Provelopment Foundation становится лучше, когда те, кто им пользуется, рассказывают о том, что нашли. Для участия не нужно быть разработчиком и не нужно разрешения; ничего не требуют и от вас. Репозиторий открыт, и речь на этой странице идёт не о том, что от вас ждут, а о том, что помогает.

Большая часть участия начинается с проблемы

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

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

Способы участвовать

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

  • Пользоваться Foundation и рассказывать о найденном

    Внедрите платформу, сделайте настоящий сайт и расскажите, что получилось, а что нет. Опыт работающего сайта — самое ценное, что может получить молодой проект.

  • Сообщать об ошибках

    Опишите ожидаемое и фактическое поведение и шаги воспроизведения. Добавьте версию Foundation, страницу или настройку, с которой работали, и текст сообщения об ошибке. Опечатка в настройке и настоящая ошибка различаются по тому, как составлен отчёт.

  • Предлагать улучшения

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

  • Улучшать документацию

    Руководства читают те, кто видит Foundation впервые. Понятная фраза, недостающее условие, исправленный пример, перевод — всё это сразу доходит до следующего читателя.

  • Предлагать техническую работу

    Код, тесты, схемы настроек, примеры для поставки. Документы в репозитории объясняют, как ведётся разработка и что нужно включить, прежде чем предлагать изменение.

  • Помогать другим

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

Править свою копию и менять проект — не одно и то же

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

Каким бывает полезный отчёт

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

Опишите ожидаемое и фактическое. Разница между ними и есть ошибка. «Переключил язык, но переключатель остался на английском» что-то сообщает, а «сайт сломался» — ничего.

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

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

Приведите сообщение дословно. Текст ошибки часто оказывается самым коротким путём к причине, а пересказ убирает как раз нужные детали.

Напишите, что уже пробовали. Это избавляет от повторения той же работы, а иногда показывает, что документация повела не туда. Это тоже ошибка — в документации.

Где находятся правила самого проекта

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

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

Сообщить об ошибке, предложить изменение

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

Что читать дальше