Как можно провести обзор кода с помощью GitHub?

GitHub обладает отличным механизмом для обсуждения коммитов и запросов на получение. Однако, если я создал репо и , мне бы хотелось, чтобы кто-то прокомментировал весь код в моем репо, что это хороший способ сделать это?

  • Записи существуют, но отображаются только окна кода за раз, поэтому мне нужно создавать коммиты, которые охватывают каждую строку всех интересующих файлов?
  • Если это так, мой лучший вариант - коснуться каждого файла, добавив пробел в конце каждой строки? (Тьфу). Я могу создать это фиксацию в ветке, а затем выдать запрос на перенос на свое собственное репо из этой ветки, чтобы не загрязнять мастер.
    • for x in <files of interest>; do sed "s/\$/ /g" $x > $x.new; mv $x.new $x; done

Здесь связанный вопрос о комментировании без коммитов.

Update:

С вдохновением от @VonC я использовал следующий процесс, который, по моему мнению, является самым простым и лучшим, поскольку он не мешает мастер-ветке или требует от моих рецензентов дополнительных усилий.

1. В моем локальном клоне моего репо я создал ветвь с именем code_review.

git checkout -b code_review

2. В этой ветке я удалил все файлы, которые я хотел просмотреть, зафиксировал это изменение и нажал.

git rm -rf *
git commit -am "files to be code reviewed"
git push origin code_review -u

3. В Github из главного ветки я выдал запрос на pull для ветки code_review. Это был вариант с главного экрана для этого проекта.

4. Наконец, я отправил своим рецензентам ссылку на этот запрос на растяжение, чтобы они могли прокомментировать мой код за строкой. Обязательно сообщите им щелкнуть вкладку "файлы изменено" для встроенного комментирования.

Ответ 1

Обновление 2016: в GitHub Universe 2016, GitHub представил расширенные обзоры

наш первый шаг теперь доступен на всех запросах на pull-Reviews. В дополнение к комментариям по конкретным строкам кода обзоры позволяют формально "утверждать" или "запрашивать изменения" для запроса запросов. Вы также можете оставить отзыв обзора и удалить, отредактировать или расслоить комментарии перед отправкой.

https://cloud.githubusercontent.com/assets/3477155/18469521/7fb32732-7976- 11e6-80cf-f2ab37688768.gif


Если вы измените ветвь по умолчанию вашего рефинга Github на пустую ветку, коллега, управляющий вилкой, должен иметь возможность выполнить запрос на перенос к вашему реестру Github, который будет показывать полный код.

Ответ 2

Github не поддерживает функцию, которая вам нужна.

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

Я также пишу этот ответ для Комментировать строку в Github без вопроса фиксации