Hva betyr kryptiske Github-kommentarer?

Er du ny i Github og / eller bidrar du til open source-prosjekter? Har du sett korte meldinger som LGTM, ACK, NACK osv. Og lurt på hva de betyr?

Værsågod:

  • LGTM - ser bra ut for meg
  • ACK - bekreftelse , dvs. avtalt / akseptert endring
  • NACK / NAK - negativ anerkjennelse , dvs. uenig med endring og / eller konsept
  • RFC - forespørsel om kommentarer, dvs. jeg synes dette er en god idé, kan vi diskutere
  • WIP - arbeid pågår, ikke slå sammen ennå
  • AFAIK / AFAICT - så vidt jeg vet / kan fortelle
  • IIRC - hvis jeg husker riktig
  • IANAL - “Jeg er ikke advokat”, men jeg lukter lisensieringsproblemer

Mange prosjekter i kryptorommet bruker også følgende ( popularisert av Bitcoins hacker-lingo ):

  • Konsept ACK - er enig i konseptet, men har ikke vurdert endringene
  • utACK (aka. Untested ACK) - enig med endringene og gjennomgått dem, men testet ikke
  • Testet ACK - enig med endringene, gjennomgått og testet

Disse svarene er vanligvis en del av prosessen med kodegjennomgang, og du finner dem i problemer eller trekker forespørsler i Github.

Æresomtale: +1 som kortform for ACK (og i mange tilfeller Concept ACK). Etter det berømte "Dear Github" -brevet, har plattformen introdusert skikkelige reaksjoner på å forkaste kommentarer. Nei, dette handler ikke om å gjøre Github til din neste Facebook :)

Du vil også se at ACK-ene blir inkludert i kommisjonsmeldinger, som hvordan Linux-kjernen gjør det siden Git blir brukt:

Add get_random_long().Signed-off-by: Daniel Cashman Acked-by: Kees Cook Cc: "Theodore Ts'o" Cc: Arnd Bergmann Cc: Greg Kroah-Hartman Cc: Catalin Marinas Cc: Will Deacon Cc: Ralf Baechle Cc: Benjamin Herrenschmidt Cc: Paul Mackerras Cc: Michael Ellerman Cc: David S. Miller Cc: Thomas Gleixner Cc: Ingo Molnar Cc: H. Peter Anvin Cc: Al Viro Cc: Nick Kralevich Cc: Jeff Vander Stoep Cc: Mark Salyzyn Signed-off-by: Andrew Morton Signed-off-by: Linus Torvalds 

Ta en titt på "Hvordan få endringen til Linux-kjernen" -guiden for en grundig forklaring.

Lignende korte svar brukes mye i programvareteknikk og open source-samfunnet ettersom de gjør kommunikasjonen mer effektiv.

Du har sikkert sett følgende i kildekoden - TODO, FIXME, XXX og NOTE - og bare lurt på hva XXX betyr?

Interessert i å se mange flere akronymer med forklaring og kanskje litt historie? Sjekk ut Jargon File. Det er den definitive kilden siden 1975.

Bonus trivia : hvor kommer ACK / NACK fra?

Jeg vil si at det kom fra nettverks- / grensesnittprotokoller, kanskje populariteten til TCP forårsaket utstrakt bruk.

SYN, SYN / ACK, ACK, FIN, ACK, FIN, ACK.