Primul pas: vrei să înțelegi problema sau vrei doar soluția?
Atunci când ai o problemă cu o bucată de cod și ai nevoie de ajutor, este de preferat ca postul tău să conțină următoarele:
- Un titlu bun
- o descriere
- exemplu de cod (și screenshot/exemplu live, dacă e cazul)
- bonus point: specificații extra (browser, versiuni folosite etc)
- bonus point: o categorie potrivită (și tag-uri)
- bonus point: dacă un răspuns te-a ajutat să rezolvi problema, marchează-l ca atare:
Un titlu bun și o descriere
Toți avem probleme și, de cele mai multe ori, nu știm cum putem rezuma în 3-4 cuvinte (pentru un titlu) și în câteva propoziții această problemă. Din experiență pot spune că ăsta este un semn că problema nu este înțeleasă pe deplin.
Acordați câteva minute pentru o formulare detaliată și fără ambiguități.
Exemple de cod
Aveți mai multe opțiuni pentru a adăuga exemple de cod astfel încât postul va arăta bine.
Prima opțiune, cea mai evidentă, toolbar-ul editorului: selectezi bucata de cod, apeși pe buton (sau Ctrl+K) și gata.
A doua opțiune este să includeți codul în backticks (accent grav). Codul inline arată așa și folosește un singur backtick, blocurile de cod au nevoie de câte trei simboluri la început și la sfârșit.
Opțional, poți specifica și limbajul:
De exemplu:
Întotdeauna pune codul în format text (nu imagine) și fii atent să nu conțină informații confidențiale (chei ssh, parole, date ale clienților etc). Forumul permite editarea unui post, dar păstrează reviziile; dacă astfel de informații scapă, trimite un mesaj unui moderator și revizia respectivă va fi ștearsă.
A treia opțiune constă în servicii externe (de genul gist, pastebin etc), dar sunt descurajate. De ce? Chiar dacă nu cred că va fi cazul cu Github, restul serviciilor pot să dispară oricând, lăsând forumul ciuntit, cu exemple de cod care nu există.
Screenshot
Dacă ai probleme cu un cod JS sau CSS, ești încurajat să adaugi un screenshot, să specifici browserul/sistemul de operare și să adaugi un exemplu live, ori pe un server propriu, ori pe servicii ce rulează codul în browser (codepen, jsfiddle, dabblet etc).
Nici screenshot-ul și nici codul live NU sunt substitute ale exemplelor de cod!
Categorie/Tag-uri
Dacă nu știi în ce categorie ar putea intra postul tău, lasă uncategorized și un moderator se va ocupa de asta. Idem și pentru tag-uri.
Bump
Oricât de important este subiectul deschis, nu uita că este important doar pentru tine. Asta înseamnă că adăugarea unui răspuns de genul „bump”, „știe cineva?”, „nu am rezolvat” etc. nu își are locul.