Skip to content

Latest commit

 

History

History
87 lines (71 loc) · 7.13 KB

author-profile.md

File metadata and controls

87 lines (71 loc) · 7.13 KB
Raw

Профиль автора

Авторы — это люди, которые вносили свой вклад в содержимое данного репозитория. Информация об авторах хранится в специальном файле authors.json.

Введение

Механизм хранения информации об авторах создан, чтобы решить часть проблем, а также дать возможность контролировать информацию о себе и рассказать немного больше:

  • Мы не можем получить достоверную информацию об авторах из git. Например, объединение нескольких файлов в один, разделения файла на несколько, а также копирование файлов для новой версии — теряют историю контрибуции и единственным контрибутором остаётся тот, кто эти изменения и сделал. Чтобы не обидеть никого, контрибуторы могут добавить информацию о себе и мы сможем контролировать авторов не опираясь на возможности git.
  • Мы не можем опираться на какой-то конкретный сервис для получения информации об авторах, будь то GitHub, GitLab и т.д. Вся информация должна быть доступна вместе с содержимым и не привязана к какому-либо из сервисов.
  • Авторы могут контролировать информацию о себе на уровне репозитория, а не конкретного сервиса или сайта.
  • Мы можем в будущем вводить новые возможности и поддержку новых данных для отображения и хранения, опять же, мы не ограничены каким-то сервисом или сайтом, это простой JSON файл.

Информация об авторах используется для отображения её на соответствующих страницах, участие в которых принимал конкретный автор.

Пример отображения информации об авторе

Схема информации об авторе

Все элементы являются обязательными, если не указано обратного.

  • slug: Идентификатор автора, как правило, никнейм. Допустимы только цифры и буквы латинского алфавита в нижнем и верхнем регистре, а также _ и -. Максимальная длина - 64 символа.
    • name: Объект с именем автора.
      • given: Имя.
      • family: Фамилия.
    • org: (опционально) Объект с информацией о месте работы автора.
      • name: Название организации, в которой работает автор.
      • unit: Подразделение или должность в организации.
    • country: Страна в формате ISO 3166-1 alpha-2 (2 буквы).
    • homepage: (опционально) Абсолютный адрес домашней странички.
    • description: (опционально) Объект с описаниями автора на различных языка. Ключи — двухбуквенное обозначение языка, значение — небольшое описание.
    • image: (опционально) Путь до фотографии автора относительно файла который правится.
    • identification: (опционально) Объект состоящий из различных значений, который будут использованы для идентификации автора, когда он явно не указан.
      • email: Массив E-mail адресов, которые используется или использовались автором для контрибуции в проект. По данным адресам будет парситься список авторов из логов для материала и искаться соответствие для автора.

Пример authors.json

Ниже представлен пример информации об авторе Dries Buytaert.

{
  "dries": {
    "name": {
      "given": "Dries",
      "family": "Buytaert"
    },
    "org": {
      "name": "Acquia",
      "unit": "CTO"
    },
    "country": "GB",
    "homepage": "https://dri.es/",
    "description": {
      "en": "I'm the founder of Drupal and Acquia. I've been working on Open Source and an Open Web for 20+ years. I'm also a blogger, photographer, traveler, investor, husband, and father of two wonderful kids."
    },
    "image": "image/dries.jpg",
    "identification": {
      "email": [
        "[email protected]",
        "[email protected]"
      ]
    }
  },
}

Добавление себя в список авторов

Для того чтобы добавить информацию об авторе, добавьте новый элемент в authors.json. Убедитесь что вы выбрали уникальный slug (путь \ идентификатор):

Требования к информации об авторе

  • Добавить информацию об авторе может только тот человек, о котором добавляется информация.
  • Данные должны быть реальные.
  • Реклама чего-либо в информации и описании об авторе запрещена.
  • Если вы решили указать фотографию, убедитесь что оно полностью соответствует следующим требованиям:
    • Фотография должна быть размещена в директории /authors/images.
    • Формат фотографии JPEG.
    • Размер фотографии 256×256.
    • Вес фотографии не более 512 Кб.
    • Название фотографии должно соответствовать slug автора, кому принадлежитфотографии.
    • Фотография должна быть фотографией. 🤔 Персонажы, абстрактные картинки и прочее — не допускаются. Это значение, в конце концов, опционально.