Mesaj kartları tasarla

Bir kartın anatomisi

Bir kartın bölümleri, yukarıdan aşağıya. İhtiyacın olmayanı çıkar: yalnızca başlığı olan bir kart da olur.

#github

Message from GitHub• acme/web

Pull request #212 açıldı

Open

Kanal listesinde daha hızlı arama

Arama artık 120 ms debounce ile her tuş vuruşunda çalışıyor.

Yazar

maya

İnceleyenler

dani, sam

10:03

+86-12

1. Üst bilgi“Message from” ve bir ad: webhook’un adı ya da bir komut yanıtında topluluğunun adı. Bir yanıt, örneğin depo adı gibi bir badge ekleyebilir.
2. Başlık ve durumtitle_url ayarladığında bağlantıya dönüşen title ve yanında status kapsülü.
3. Alt başlıkİkinci bir kalın satır, sub_title.
4. AçıklamaMarkdown ile yazılan gövde.
5. AlanlarKopyalama düğmeli etiket ve değer satırları.
6. Alt bilgiSaat ve gönderirsen eklenen ve silinen satırlar.

{
  "message_container": {
    "type": "embed_message",
    "badge": "acme/web",
    "color": "purple",
    "title": "Pull request #212 opened",
    "title_url": "https://github.com/acme/web/pull/212",
    "status": { "label": "Open", "color": "green", "icon": "pull_request" },
    "sub_title": "Faster search in the channel list",
    "description": "Search now runs **per keystroke** with a 120 ms debounce.",
    "fields": [
      { "field": "Author", "value": "maya" },
      { "field": "Reviewers", "value": "dani, sam" }
    ],
    "additions": 86,
    "deletions": 12,
    "files_changed": 3
  }
}

Tüm alanlar

Bunlar message_container içine girer. Bir kartın bir açıklamaya ya da bir yükleme göstergesine ihtiyacı vardır. “Komut yanıtları” olarak işaretlenen alanlar, webhook üzerinden gönderdiğinde atılır.

Durum ve diff istatistikleri

Durum kapsülü, kimse metni okumadan hikâyeyi anlatır. Başlığın yanında, başlık yoksa alt bilgide durur; diff istatistikleri saatin yanında görünür. İkisi de komut yanıtlarında çalışır ve yerleşik GitHub entegrasyonu da bunları kullanır. Bir webhook ise bunları atar.

#github

Message from GitHub• acme/web

Pull request #212 birleştirildi

Merged

11:20

Message from CI• acme/web

Build, main dalında başarısız oldu

Failing

search.test.js: 212 testten 2’si başarısız oldu.

11:24

Message from GitHub• acme/web

maya, main dalına push yaptı

Commit

11:31

+14-3

{
  "message_container": {
    "color": "red",
    "title": "Build failed on main",
    "status": { "label": "Failing", "color": "red" },
    "description": "`search.test.js`: 2 of 212 tests failed."
  }
}

Simgeler

GitHub için işe yarayan bir eşleme

Yerleşik GitHub entegrasyonu bunları kullanır; kendi araçların için kopyala.

Yükleme ve akıl yürütme

Bir yapay zekâ yanıtı ya da uzun bir iş gibi biraz zaman alan her şey için önce dönen bir yükleme simgesi olan bir kart gönder, sonra onu sonuçla değiştir. Yükleme göstergesi webhook’larda ve komut yanıtlarında çalışır. Bir komut yanıtında modelin akıl yürütmesini thinking içine de koyabilirsin: üyeler bir metin duvarı yerine bir Show thinking düğmesi görür.

#assistant

Message from Assistant

Düşünüyorum…Son 50 mesajı okuyorum

09:02

Önce: yükleme göstergesi

#assistant

Message from Assistant

maya: standup ne zaman?

Standup saat 09:30’da, #daily kanalında.

Show thinking

Sabitlenmiş mesajları ve #daily kanalındaki tekrarlayan etkinliği kontrol ettim.

09:02

Sonra: yanıt, akıl yürütme katlanmış halde

{
  "message_container": {
    "type": "embed_message",
    "color": "blue",
    "loader": true,
    "loader_text": "Thinking…",
    "loader_sub_text": "Reading the last 50 messages"
  }
}

{
  "message_container": {
    "type": "embed_message",
    "color": "blue",
    "sub_title": "maya: when is the standup?",
    "description": "Standup is at **09:30**, in #daily.",
    "thinking": "Checked the pinned messages and the recurring event in #daily…"
  }
}

Yükleme göstergesini yanıtla değiştirmek için mesajı loader içermeyen yeni bir kartla güncelle. Nasıl yapılacağı canlı güncellemeler sayfasında.

Uzun açıklamalar

Bir açıklama 50.000 bayta kadar olabilir. İlk 1.000 bayt aşıldığında üyeler başlangıcı ve geri kalanını yükleyen bir Show more düğmesi görür, böylece uzun bir rapor kanalı doldurmaz.

Sistem mesajları

Bir bot gönderisi yerine bir duyuru için "type": "system_message" ayarla: bakım aralıkları, kural değişiklikleri, topluluğun kendisi adına konuşan her şey. Aynı alanları ve düğmeleri kabul eder.

{
  "message_container": {
    "type": "system_message",
    "color": "orange",
    "title": "Maintenance tonight",
    "description": "The build servers are down from 22:00 to 23:00."
  }
}

Renkler

Kenar rengi, bir karttaki en hızlı sinyaldir. Aynı tür haber için her seferinde aynı rengi kullan.