Документация Engee

Сотрудничество

Добавление изображений

Любой желающий может добавить изображения в этот репозиторий, отправив запрос на вытягивание в репозиторий GitHub.

Шаг 1. Добавление изображений в ветвь images

Для добавления изображения или набора изображений в репозиторий необходимо выполнить следующие действия.

  1. Перед добавлением изображений проверьте их на наличие проблем с авторскими правами или лицензией.

  2. В папке локального репозитория выполните команду git checkout images. Расположение репозитория можно определить с помощью Pkg.dir("TestImages").

  3. Добавьте изображение в локальную папку images/ на компьютере.

  4. Если есть метаданные, более распространенное имя, URL-адрес источника или автор, их можно добавить в images/metadata.toml.

  5. Чтобы подготовить изменения для фиксации, выполните команду git add --all.

  6. git commit -m "Adds <filename> to the repository from link <link>"

  7. git push <fork> images

  8. Теперь отправьте запрос на вытягивание к ветви images. После принятия изображение или набор изображений сохраняются в https://github.com/JuliaImages/TestImages.jl/blob/images/images/<filename>.

После добавления изображений в репозиторий специалисты по обслуживанию создают тег v*-artifacts (например, v1.5.0-artifacts) для ветви images и отправляют его в репозиторий. После этого запускается действие непрерывной интеграции GitHub, определенное в ветви images, и выполняются сборка и выпуск артефакта tar-архива для этой фиксации.

Шаг 2. Обновление ветви master

Следующим шагом является изменение исходных файлов пакета TestImages.jl, чтобы сделать их доступными для скачивания, то есть их добавление в список remotefiles.

  1. Чтобы вернуться в ветвь master, выполните команду git checkout master.

  2. Измените src/TestImages.jl: добавьте запись с именем файла в словарь remotefiles.

  3. Измените Artifacts.toml: обновите раздел [images], добавив новые выпущенные артефакты.

  4. Чтобы добавить измененные файлы исходного кода, выполните команду git add --all.

  5. git commit -m "Adds <filename> to package"

  6. git push <fork> master

  7. Теперь отправьте запрос на вытягивание к ветви master. После принятия изображение или набор изображений будут доступны для скачивания пользователям TestImages.jl.

Пример см. в запросе на вытягивание № 123.

Прочее

Вы можете свободно создавать проблемы или запросы на вытягивание. Если у вас есть вопросы, вы можете задать их в Discourse или на канале #image-processing в Slack.