Masaüstü uygulaması

Kod İnceleme Gelen Kutusu Uygulama Tasarımı

Kod İnceleme Gelen Kutusu Uygulama Tasarımı; inceleme isteklerini, CI hatalarını, atanmış sorunları ve etkinlikleri günlük önceliklendirme için hızla gözden geçirilebilen tek bir çalışma alanında bir araya getirir.

OpenDesignTasarım ve prodüksiyon
Resmi
GitHub inceleme isteği ve bahsetme gelen kutusu2 ekran
Koyu renkli bir üst çubuğun altında inceleme istekleri, kırmızı bir CI uyarısı ve sorun etkinliği bulunan açık renkli kod inceleme gelen kutusu.
Kod İnceleme Gelen KutusuEkran görüntüsü 1 / toplam 2

Kod İnceleme Gelen Kutusu Uygulaması Kullanım Senaryoları

  • İnceleme İsteği ÖnceliklendirmesiOnayları, açık pull request'leri ve bekleyen yanıtları tek bir kuyrukta bulun.
  • CI Hatası İzlemeBaşarısız kontrolleri, takip için gereken commit bağlamıyla birlikte öne çıkarın.
  • Sorun ÖnceliklendirmesiAtanmış işleri depo, durum, etiketler ve son etkinlik bilgileriyle tarayın.
  • Mühendislik Etkinliği İncelemesiBirleştirilmiş değişiklikleri acil işlerle karıştırmadan görünür tutun.

İnceleme Gelen Kutusu Tasarımının Öne Çıkanları

  • Önce ÖnceliklerSarı inceleme panelleri, sizi bekleyen işleri en üste yerleştirir.
  • Bağlam İçinde KanıtKompakt bir kod diff'i, ilgili inceleme isteğinin içinde yer alır.
  • Duruma Dayalı RenkYeşil, kırmızı, sarı ve mor, iş akışı durumlarını birbirinden ayırır.
  • Tek Çalışma Alanıİstekler, kontroller, sorunlar ve etkinlikler tek bir okuma akışını paylaşır.

Kod İnceleme Gelen Kutusu Yapısı

Bu masaüstü uygulaması tasarımı, GitHub inceleme isteği ve bahsetme gelen kutusunu dikey olarak sıralanmış bir çalışma alanı şeklinde sunar. Sol kenar çubuğu “All 5” ile başlar; bunu “Participating”, “Mentions” ve “Review requests 2” izler. Ana sütun daha sonra işleri inceleme istekleri, CI kontrolleri, atanmış sorunlar ve etkinlikler olarak gruplandırır. Bu sıralama, çeşitli mühendislik sinyallerini tek bir tarama yoluna dönüştürürken ayrı kategoriler önce neyin ilgi gerektirdiğine karar vermek için yeterli bağlamı korur.

Sol filtreleri ve sıralanmış inceleme, CI, sorun ve etkinlik panellerini gösteren eksiksiz Kod İnceleme Gelen Kutusu çalışma alanı.
Sol filtreleri ve sıralanmış inceleme, CI, sorun ve etkinlik panellerini gösteren eksiksiz Kod İnceleme Gelen Kutusu çalışma alanı.

Kanıt Olarak İnceleme İsteği

İlk inceleme öğesi, open-design/web PR #2371'i tanımlar, “feat: orbit briefing card” adını verir ve “3 of 5 reviewers approved · waiting on you + cody” ifadesini gösterir. Altında, “src/components/OrbitBriefingCard.tsx” dosya yolu kaldırılan ve eklenen satırları içeren kompakt bir diff'i tanıtır. Bu eşleştirme, incelemeyi yapan kişinin onay durumunu somut bir değişiklikle ilişkilendirmesini sağlar. Bunun karşılığında dikey yoğunluk artar: Kod alıntısı yararlı bağlam ekler, ancak ilk öğeyi ikinci istekten önemli ölçüde daha uzun hâle getirir.

Mühendislik Önceliklendirmesi Kullanım Senaryoları

Tasarım, birbirinin aynı türünde işlermiş gibi davranmadan birkaç farklı görevi destekler. İnceleme istekleri yanıt veya onay ister, CI kontrolleri başarısız bir doğrulama durumuna işaret eder, atanmış sorunlar sahiplenilmiş birikim işlerini temsil eder ve etkinlik, tamamlanmış bir değişikliği kaydeder. Bu grupları ayrı paneller olarak tutmak, görev sınırını görünür kılar. Bunun karşılığında ilişkili sinyaller tek bir evrensel puanda yoğunlaştırılmak yerine sayfa genelinde dağınık kalır.

Bekleyen İnceleme

Sarı “Review requests waiting on you” başlığı 2 sayısını taşır. İlk satırı, incelemeci avatarları ve açık bir bekleme durumu içeren açık bir pull request'tir; ikinci satır ise “Conversation needs your reply” der ve @cody'yi belirtir. Her ikisi de eylem gerektirse de etiketler onay işini konuşma işinden ayırır.

Başarısız Doğrulama

Kırmızı “CI / Checks” paneli tek bir öğe içerir: open-design/web · main · “test (e2e) failed”. Yakındaki son commit metni “chore(deps): bump cheerio to 1.0.2”, testin neden başarısız olduğuna ilişkin bir iddiada bulunmadan olası bir inceleme dayanağı sağlar. Kırmızı vurgu durumu öne çıkarır, ancak nasıl giderileceğini açıklamaz.

Sahiplenilmiş ve Tamamlanmış İşler

Sorun satırı, “Auth middleware refactor” ifadesini Open durumu, “backend” etiketi ve “p1” ile birleştirir. Altındaki etkinlik satırı, PR #2401'in bob tarafından main dalına birleştirildiğini gösterir. Bu sıralama çözümlenmemiş sorumlulukları tamamlanmış geçmişin üzerinde tutar; ancak sayfa yine de okuyucunun aciliyeti etiketlerden ve durumdan yorumlamasını gerektirir.

Çalışma Alanı Okuma Akışı

Çalışma alanı, eşit boyutlu pano kutucukları yerine geniş bir ana sütun ve kompakt bir gezinme çubuğu kullanır. Sunulan CSS, maksimum sayfa genişliğini 1280px olarak belirler ve görünür düzen, yatay alanın çoğunu olay panellerine ayırır. Bu oran; uzun depo adlarını, pull request başlıklarını, zaman damgalarını ve kod satırlarını her öğeyi ayrı bir kart sütununa sıkıştırmadan destekler. Bunun bedeli, özellikle inceleme isteği gömülü diff'ini içerdiğinde uzun bir dikey taramadır.

İnceleme Paneli

Sarı başlık, sayı rozeti, açık durum rozetleri, incelemeci avatarları ve kod diff'i, aciliyeti kanıtla birleştirir.

CI Paneli

Kırmızı başlık ve başarısız kontrol satırı, doğrulama sorununu inceleme ve sorumluluk işlerinden ayırır.

Sorun Paneli

Durum ve etiketler, atanmış öğenin iş akışı durumunu ve kategorisini kısa bir satırda gösterir.

Etkinlik Paneli

Mor birleştirilmiş görünümü, yukarıdaki çözümlenmemiş öğelerle rekabet etmeden tamamlanmış geçmişi belirtir.

Filtreden Ayrıntıya

Üst arama alanında Type / to search yazar, ancak bir arama işleyicisi yoktur. Kenar çubuğu filtreleri sağlanan yerel gruplar üzerinde çalışır: Participating inceleme isteklerini ve atanmış sorunları, Review requests inceleme grubunu, Mentions ise yalnızca kaynağın bahsetme işaretini taşıyan grubu gösterir. Bu işaret, yanıt gereken inceleme satırına değil atanmış sorunlara eklenmiştir. Filtreleme, bağlı bir GitHub araması veya gelen kutusu hizmeti değil, yerel bir sunum davranışıdır.

Renklerle Durum Değişiklikleri

Renk, diğer yönlerden benzer olan satırlarda durumu aktarır. Yeşil açık veya sağlıklı görünen depo durumlarını, sarı yanıt bekleyen işleri, kırmızı başarısız testi ve mor birleştirilmiş etkinlik öğesini belirtir. Sorun etiketleri, “backend” ve “p1” için ayrı mavi ve pembe rozetler kullanır. Bu yaklaşım taramayı her cümleyi okumaktan daha hızlı hâle getirir, ancak renk destekleyici olmaya devam eder: Her durum metin olarak da yazılmıştır; böylece rengin tek başına yetersiz kaldığı durumlarda anlam korunur.

Yetenek Sınırı

Kaynak, yerel kategori filtrelemesini uygular ve satırlar ile başlıklar için dışa giden GitHub bağlantıları oluşturur. Bu bağlantılar, gösterilen örnek tanımlayıcıları kullanarak sabit bir depoya yönelir; var olmaları tasvir edilen pull request'leri, sorunları veya CI sonuçlarını doğrulamaz. Arama, kimliği doğrulanmış gelen kutusu verilerinin alınması, kalıcı inceleme durumu ve gerçek test yürütümü uygulanmamıştır. Adlar, sayılar, zaman damgaları, onay durumları ve kod alıntıları, tasarım senaryosu için temsili içerik olarak kalır.

OpenDesign'da Kod İnceleme Gelen Kutusu Uygulama Tasarımı Nasıl Oluşturulur?

  1. OpenDesign'ı İndirin ve Kurun

    Masaüstü uygulamasını indirin, kurun ve kurulumu tamamlayın. Tasarımınız için bir proje oluşturun.

    OpenDesign'ı İndir
  2. Çalışma Alanı Sırasını Belirleyin

    “All”, “Participating,” “Mentions” ve “Review requests” için kalıcı bir sol kenar çubuğu ile onu izleyen geniş bir ana sütundan oluşan masaüstü çalışma alanı oluşturun. Çözümlenmemiş işler geçmişten önce gelsin diye önce inceleme isteklerini, ardından CI kontrollerini, atanmış sorunları ve etkinlikleri yerleştirin.

  3. Vakaya Özgü Durumları Ekleyin

    PR #2371 ve PR #2389 için örnek satırlar, main dalında başarısız bir “test (e2e)” kontrolü, atanmış ENG-148 sorunu ve birleştirilmiş PR #2401 etkinlik öğesi kullanın. “waiting on you”, “Conversation needs your reply”, “backend” ve “p1” gibi açık etiketleri koruyun.

    Önerilen Prompt

    Kalıcı bir sol filtre çubuğuna ve geniş, gruplandırılmış bir çalışma alanına sahip masaüstü Kod İnceleme Gelen Kutusu Uygulama Tasarımı oluşturun. Önce inceleme isteklerini gösterin; bunlara kompakt bir OrbitBriefingCard.tsx diff'i içeren PR #2371'i ve yanıt gerektiğini belirten duruma sahip PR #2389'u dahil edin. Ardından başarısız bir test (e2e) içeren CI / Checks bölümünü, ENG-148'i içeren Issues assigned to you bölümünü ve birleştirilmiş PR #2401'i içeren Activity bölümünü gösterin. Yalnızca temsili yerel veriler kullanın ve canlı bir GitHub bağlantısı, backend, depolama ya da gerçek test yürütümü bulunduğu izlenimini vermeyin.

  4. Tarama Düzenini İyileştirin

    Sarı inceleme vurgusunun, kırmızı CI hatası görünümünün, yeşil açık durumların ve mor birleştirilmiş etkinliğin yazılı etiketlerle birlikte okunabilir kaldığını kontrol edin. Kod alıntısını inceleme satırına göre ikincil tutun, uzun depo ve dosya adlarını koruyun ve çalışma alanı daraldığında dikey gruplandırmanın hâlâ doğru okunabildiğini doğrulayın.

  5. Dışa Aktarın ve Paylaşım Bağlantısı Alın

    Bitmiş tasarımınızı dışa aktarın, ardından bir paylaşım bağlantısı almak için OpenDesign'daki Paylaş seçeneğini kullanın. Bağlantıyı göndermeden önce ayrı bir tarayıcı penceresinde açarak amaçlanan sürümün ve bileşenlerinin erişilebilir olduğunu doğrulayın.