Kadang-kadang perlu untuk meninggalkan umpan balik tentang kode sumber dalam repositori secara keseluruhan, misalnya, ketika menerima kode untuk dukungan dari pengembang lain atau saat menghubungkan ke proyek baru.
Proses peninjauan di Github dan analognya dibangun di sekitar perubahan yang dibuat, dan dalam kasus kami, komentar perlu diberikan pada status seluruh kode sistem pada saat berkomentar.
Cara melakukannya menggunakan git sendiri: perbaiki keadaan di cabang ulasan, lalu tinggalkan komentar Anda di permintaan penggabungan untuk cabang ini.
Secara umum, esensi dari metode ini telah dinyatakan, di bawah ini hanya beberapa detail.
Isu
Bayangkan situasinya: mereka memberi Anda repositori dengan kode dan meminta pendapat Anda tentangnya. Biasanya dalam kasus seperti itu, komentar dibuat dalam dokumen / tugas / halaman terpisah, dll., Yang sangat tidak nyaman karena:
- Komentar dapat menjadi usang selama proses penulisan, karena pengembangan dapat berlanjut.
- Sulit untuk merujuk ke bagian individual dari kode, referensi seperti ragu / bar.js: 4 tidak nyaman untuk terus berpindah antara dokumen dan kode.
- Dalam isolasi dari kode, dokumen tersebut hilang dengan probabilitas yang agak tinggi.
Metode tinjauan kode sistem
, : , merge request .
https://github.com/oktend/system-review-example :
- ( dev):
https://github.com/oktend/system-review-example/commit/0514531a35edf19e7032eb49f45a98d019f83efe - , "system-review/1march2020-goodman":
https://github.com/oktend/system-review-example/tree/system-review/1march2020-goodman - , , "1march2020-goodman-issues":
https://github.com/oktend/system-review-example/tree/system-review/1march2020-goodman-issues - , , .
- merge request ( pull request) "system-review/1march2020-goodman-issues" -> "system-review/1march2020-goodman":
https://github.com/oktend/system-review-example/pull/1/files
:
https://github.com/oktend/system-review-example/network
merge request , .
, .
:
https://github.com/oktend/system-review-example/blob/c80b03710059b235347ec781bf08dca9c0e68f7d/review-1march2020-goodman.md
:
https://github.com/oktend/system-review-example/blob/c80b03710059b235347ec781bf08dca9c0e68f7d/foo.js
- github ( ), IDE, git.
, .
Saya sepenuhnya mengakui kemungkinan bahwa saya menemukan kembali sepeda dan bahwa ada metode yang lebih baik untuk kasus-kasus seperti itu, maka saya akan bersyukur karena menunjukkan cara terbaik.
Gagasan untuk metode ini tidak ditemukan oleh saya, tetapi disarankan oleh satu pengembang, jika Artem menyatakan keinginan, saya akan menunjukkan sebagai penulis.