Развитие в AMP

Как начать работу

Перед тем как начать разработку в AMP, ознакомьтесь с этими ресурсами:

• contributing.md содержит подробную информацию о различных способах участия в открытом проекте AMP.
  • Если вы разрабатываете в AMP, вам следует ознакомиться с документацией Участие в разработке кода и функций, которая включает информацию о проверках кода и утверждениях.
  • Раздел Продолжающееся участие содержит подробную информацию о различных способах взаимодействия с сообществом, включая электронную почту и Slack.
  • Если вы новичок в открытом исходном коде, Git/GitHub и т.д., ознакомьтесь с советами для новых участников открытого исходного кода, которые включают информацию о получении помощи и нахождении первого бага для исправления.
• Краткое руководство по началу работы содержит шаги по установке и базовые инструкции для одноразовой настройки, как собрать AMP и запустить локальный сервер и как тестировать AMP.

Правила и стиль

Перед тем как начать писать код, обратитесь к этим ресурсам для получения руководства и правил:- Дизайн: Принципы дизайна AMP

• JavaScript: Руководство по стилю Google для JavaScript
• CSS: Написание CSS для AMP Runtime
• Создание новых компонентов:
  • Инструкции и руководства по созданию AMP-компонента
  • Посмотрите это видео на YouTube, чтобы узнать о "создании нового AMP-компонента"
• Интеграция сторонних программ, встраиваемых сервисов: Руководства## Тестирование

Для большинства разработчиков инструкции в Кратком руководстве по началу работы будут достаточными для сборки/запуска/тестирования во время разработки.

Для подробной информации о тестировании, см. testing.md.## Структура репозитория

  3p/             - Реализация песочниц для сторонних iframes.
  ads/            - Модули, реализующие конкретные сети рекламы, используемые в 
  build/          - (сгенерировано) промежуточные сгенерированные файлы
  build-system/   - Система сборки
  builtins/       - Теги, встроенные в основной AMP runtime
      *.md        - Документация по использованию встроенных тегов
      *.js        - Исходный код для встроенных тегов
  css/            - По умолчанию css
  dist/           - (сгенерировано) Основные JS бинарники создаются здесь. Это то, что
                    развертывается на cdn.ampproject.org.
  dist.3p/        - (сгенерировано) JS бинарники и HTML файлы для сторонних вставок и рекламы
                    Это то, что развертывается на 3p.ampproject.net.
  docs/           - Документация для людей, вносящих вклад в AMP
  examples/       - Примеры файлов AMP HTML и соответствующих активов
  extensions/     - Плагины, расширяющие основной набор тегов AMP HTML runtime
  spec/           - Файлы спецификации AMP HTML
  src/            - Исходный код для AMP runtime
  test/           - Тесты для AMP runtime и встроенных тегов
  testing/        - Система тестирования
  third_party/    - Сторонние коды, используемые в AMP
  tools/          - Код для инструментов AMP
  validator/      - Инструменты и запускные файлы для валидатора AMP

В целом мы поддерживаем последние 2 версии основных браузеров, таких как Chrome, Firefox, Edge, Safari, Opera и UC Browser. Мы поддерживаем десктопные, мобильные, планшетные версии и веб-просмотренные версии этих браузеров. Для iOS мы поддерживаем последние 2 основные версии, что охватывает примерно 2 года.

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

В частности, мы стремимся поддерживать "возможность использования, хотя она и не идеальна, но работает" для iOS 8, системного браузера Android 4.0 и Chrome 41.

Документация на английском языке

• Жизненный цикл AMP *
• Система размещения AMP
• Создание расширения AMP

Также рекомендуется ознакомиться с спецификацией. Некоторые аспекты дизайна могут быть лучше поняты, если ознакомиться с неэлементной частью спецификации.

Сборки и выпуски- Сотрудник на дежурстве по сборке AMP помогает обеспечивать, что сборки AMP остаются зелёными (то есть все собирается и все тесты проходят). Если вы столкнулись с проблемами сборки, которые не связаны с вашими изменениями, проверьте наличие проблемы на CircleCI и отправьте сообщение в канал #contributing на Slack (регистрация на Slack).

• Понимание процесса выпуска AMP полезно для понимания, когда изменения в AMP будут внесены в продакшн, и что делать, если что-то пойдет не так во время внесения изменений.### Включение в предварительные выпуски

Разработчики и пользователи AMP могут настроить свой браузер для запроса файлов AMP JS из предварительных выпусков (beta, experimental и nightly) для всех запросов, используя механизм включения. Чтобы включить ваш браузер в предварительную версию канала, перейдите на страницу AMP экспериментов и активируйте канал экспериментов по вашему выбору (см. Бета/Экспериментальный и Ночной каналы в документе процесса выпуска для описания этих каналов). Пожалуйста, подпишитесь на нашу низкочастотную рассылку для получения уведомлений о важных/разрушительных изменениях в AMP.Примечания:- Когда вы подключаетесь к предварительной версии канала с помощью механизма cookie, вы влияете только на библиотеки AMP JS в вашем браузере.

• Альтернативой использованию cookie для подключения страницы к этим предварительным версиям каналов является добавление ?optin=experimental/?optin=beta к URL AMP runtime (например, https://cdn.ampproject.org/v0.js?optin=beta).

  • URL-базированный opt-in следует использовать только для целей разработки.
  • Такое использование приведет к тому, что AMP валидатор отметит вашу страницу как некорректную и не позволит ей быть включенной в кэши AMP.
  • Нет корректного способа заставить посетителей вашего сайта использовать версию AMP Experimental/Beta Channel.Если вы обнаружили проблему, которая кажется уникальной для версии AMP в Experimental/Beta Channel:

• пожалуйста отправьте отчет о баге с описанием проблемы

  • включите примечание о том, что проблема нова для сборки Experimental/Beta Channel, чтобы она могла быть правильно приоритизирована
  • включите URL страницы, которая воспроизводит проблему

• сообщите в канале AMP Slack #release (зарегистрируйтесь для доступа к Slack) о том, что вы отправили, чтобы мы могли задержать выпуск версии Experimental/Beta Channel в продакшн, если это необходимо

Код поведения