Σχεδίασε κάρτες μηνυμάτων

Η ανατομία μιας κάρτας

Τα μέρη μιας κάρτας, από πάνω προς τα κάτω. Παράλειψε ό,τι δεν χρειάζεσαι: μια κάρτα μόνο με τίτλο είναι εντάξει.

#github

Message from GitHub• acme/web

Άνοιξε το pull request #212

Open

Ταχύτερη αναζήτηση στη λίστα καναλιών

Η αναζήτηση τρέχει πλέον σε κάθε πάτημα πλήκτρου, με debounce 120 ms.

Συντάκτης

maya

Αξιολογητές

dani, sam

10:03

+86-12

1. Κεφαλίδα«Message from» και ένα όνομα: το όνομα του webhook ή, σε απάντηση εντολής, το όνομα της κοινότητάς σου. Μια απάντηση μπορεί να προσθέσει ένα badge, όπως το αποθετήριο.
2. Τίτλος και κατάστασηΤο title, που γίνεται σύνδεσμος όταν ορίσεις title_url, με την ένδειξη status δίπλα του.
3. ΥπότιτλοςΜια δεύτερη γραμμή με έντονα, το sub_title.
4. ΠεριγραφήΤο κυρίως κείμενο, σε markdown.
5. ΠεδίαΓραμμές με ετικέτα και τιμή, με κουμπί αντιγραφής.
6. ΥποσέλιδοΗ ώρα, και οι γραμμές που προστέθηκαν και αφαιρέθηκαν, αν τις στείλεις.

{
  "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
  }
}

Όλα τα πεδία

Αυτά μπαίνουν στο message_container. Μια κάρτα χρειάζεται περιγραφή ή loader. Τα πεδία με τη σήμανση «Απαντήσεις σε εντολές» παραλείπονται όταν δημοσιεύεις μέσω webhook.

Κατάσταση και στατιστικά diff

Μια ένδειξη κατάστασης λέει την ιστορία πριν διαβάσει κανείς το κείμενο. Βρίσκεται δίπλα στον τίτλο ή, όταν δεν υπάρχει τίτλος, στο υποσέλιδο. Τα στατιστικά diff εμφανίζονται δίπλα στην ώρα. Και τα δύο λειτουργούν σε απαντήσεις εντολών, και τα χρησιμοποιεί η έτοιμη ενσωμάτωση GitHub. Ένα webhook τα παραλείπει.

#github

Message from GitHub• acme/web

Έγινε merge το pull request #212

Merged

11:20

Message from CI• acme/web

Το build απέτυχε στο main

Failing

search.test.js: απέτυχαν 2 από τα 212 τεστ.

11:24

Message from GitHub• acme/web

maya: push στο main

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."
  }
}

Εικονίδια

Μια αντιστοίχιση που δουλεύει για το GitHub

Η έτοιμη ενσωμάτωση GitHub χρησιμοποιεί αυτές τις τιμές. Αντίγραψέ τες για τα δικά σου εργαλεία.

Loader και συλλογισμός

Για ό,τι παίρνει λίγο χρόνο, όπως μια απάντηση AI ή μια μεγάλη εργασία, δημοσίευσε πρώτα μια κάρτα με spinner και μετά αντικατάστησέ τη με το αποτέλεσμα. Ο loader λειτουργεί σε webhooks και σε απαντήσεις εντολών. Σε απάντηση εντολής μπορείς επίσης να βάλεις τον συλλογισμό του μοντέλου στο thinking: τα μέλη βλέπουν έναν διακόπτη Show thinking αντί για έναν τοίχο κειμένου.

#assistant

Message from Assistant

Σκέφτομαι…Διαβάζω τα τελευταία 50 μηνύματα

09:02

Πρώτα: ο loader

#assistant

Message from Assistant

maya: πότε είναι το standup;

Το standup είναι στις 09:30, στο #daily.

Show thinking

Έλεγξα τα καρφιτσωμένα μηνύματα και το επαναλαμβανόμενο συμβάν στο #daily.

09:02

Μετά: η απάντηση, με τον συλλογισμό διπλωμένο

{
  "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…"
  }
}

Για να αντικαταστήσεις τον loader με την απάντηση, ενημέρωσε το μήνυμα με μια νέα κάρτα χωρίς loader. Πώς γίνεται θα το βρεις στις ζωντανές ενημερώσεις.

Μεγάλες περιγραφές

Μια περιγραφή μπορεί να φτάσει τα 50.000 bytes. Μετά τα πρώτα 1.000, τα μέλη βλέπουν την αρχή και ένα κουμπί Show more που φορτώνει τα υπόλοιπα, ώστε μια μεγάλη αναφορά να μην πλημμυρίζει το κανάλι.

Μηνύματα συστήματος

Όρισε "type": "system_message" για μια ανακοίνωση αντί για ανάρτηση bot: παράθυρα συντήρησης, αλλαγές κανόνων, ό,τι μιλά εκ μέρους της ίδιας της κοινότητας. Δέχεται τα ίδια πεδία και κουμπιά.

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

Χρώματα

Το χρώμα της άκρης είναι το πιο γρήγορο σήμα σε μια κάρτα. Χρησιμοποίησε το ίδιο χρώμα για το ίδιο είδος είδησης, κάθε φορά.