Руководство для сопровождающих rclone

Текущие активные сопровождающие rclone:

Это черновик, работа продолжается

Это руководство о том, как стать сопровождающим rclone. В основном это описание того, что я ( @ncw) пытаюсь сделать.

Расстановка приоритетов заявок

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

Rclone использует следующие метки:

• bug — определённо подтверждённая ошибка;
• can't reproduce — проблема, которую мы не можем воспроизвести;
• doc fix — ошибка в документации — если пользователям нужна помощь в понимании документации, добавьте эту метку;
• duplicate — обычно закрывайте их и просите пользователя подписаться на оригинал;
• enhancement: new remote — новый бэкенд rclone;
• enhancement — новая функция;
• FUSE — относится к команде rclone mount;
• good first issue — отметьте это, если вы найдёте небольшую автономную проблему — они отображаются новым посетителям проекта;
• help wanted — отметьте это, если вы найдёте автономную проблему — они отображаются новым посетителям проекта;
• IMPORTANT — обратите внимание сопровождающим, чтобы не забыть исправить это для выпуска;
• maintenance — внутреннее улучшение, реорганизация кода и т. д.;
• Needs Go 1.XX — ожидание выпуска этой версии Go;
• question — не bug или enhancement — обращайтесь на форум в следующий раз;
• Remote: XXX — какой бэкенд rclone это затрагивает;
• thinking — ещё не определились с планом действий.

Если это окажется ошибкой или улучшением, её следует пометить соответствующим образом с соответствующими другими тегами. Не забудьте поставить тег «хорошая первая проблема», чтобы дать новым участникам возможность легко начать работу.

Когда заявка помечена, её следует добавить в веху, либо в следующий выпуск, либо через один выпуск, либо скоро, либо требуется помощь. Ошибки можно добавить в веху «Известные ошибки», если они не планируется исправлять или нужно чего-то подождать (например, следующего выпуска go).

Вехи имеют следующие значения:

• v1.XX — материал, который мы хотели бы включить в этот выпуск;
• v1.XX+1 — материал, который мы оставляем до следующего выпуска;
• Скоро — материал, который, по нашему мнению, является хорошей идеей — ждём, когда его запланируют к выпуску;
• Требуется помощь — идеи, которые могут быть реализованы, или кто-то может помочь;
• Известные ошибки — ошибки, ожидающие внешних факторов, или мы не собираемся их исправлять на данный момент.

Заявки без вехи являются хорошими кандидатами на те, которые ускользнули и требуют внимания.

Закрытие заявок

Закрыть Заявки Постарайтесь как можно скорее обработать заявки!

Разместите в заявке ссылку на бета-версию с исправлением и попросите оставить отзыв.

Запросы на включение

Старайтесь оперативно обрабатывать запросы на включение!

Слияние запросов на включение в самом GitHub работает довольно хорошо, так что вы можете объединять и перебазировать или перебазировать запросы на включение. Rclone не использует коммиты слияния. Используйте опцию squash и rebase, если вам нужно отредактировать сообщение коммита.

После объединения коммита в вашей локальной основной ветке выполните git pull, затем запустите bin/update-authors.py, чтобы обновить файл авторов, а затем git push.

Иногда запросы на включение необходимо оставить открытыми на некоторое время — это особенно актуально для новых бэкендов, которые требуют много времени для правильной настройки.

Слияния

Если вы выполняете слияние ветки локально, то выполните git merge --ff-only branch-name, чтобы избежать коммита слияния. Вам потребуется перебазировать ветку, если она не сливается чисто.

Цикл выпуска

Rclone стремится к циклу выпуска в 6–8 недель. Иногда цикл выпуска занимает больше времени, если есть что-то большое, что не было должным образом стабилизировано, или по личным причинам.

Регрессии, оказывающие большое влияние, должны быть исправлены до следующего выпуска.

В начале цикла выпуска зависимости следует обновить с помощью make update, чтобы дать время проявиться ошибкам.

Ближе к концу цикла выпуска старайтесь не объединять слишком большие объёмы, дайте вещам улечься.

Следуйте инструкциям в RELEASE.md для создания релиза. Обратите внимание, что часть тестирования занимает больше всего времени и часто требует нескольких раундов тестирования и исправления в зависимости от того, сколько новых функций получил rclone.

Список рассылки

Теперь существует список рассылки только для приглашённых разработчиков rclone dev@rclone.org в группах Google.

Задачи

Вероятно, мне стоит зарегистрироваться у облачных провайдеров на dev@rclone.org.