Que signifient les commentaires cryptiques sur Github?

Êtes-vous nouveau sur Github et / ou contribuez-vous à des projets open source? Avez-vous vu des messages courts comme LGTM, ACK, NACK, etc. et vous êtes-vous demandé ce qu'ils signifient?

Voici:

  • LGTM - me va bien
  • ACK - accusé de réception , c'est-à-dire changement accepté / accepté
  • NACK / NAK - reconnaissance négative , c'est-à-dire en désaccord avec le changement et / ou le concept
  • RFC - demande de commentaires, c'est à dire je pense que c'est une bonne idée, discutons
  • WIP - travail en cours, ne pas encore fusionner
  • AFAIK / AFAICT - pour autant que je sache / peux dire
  • IIRC - si je me souviens bien
  • IANAL - «Je ne suis pas avocat», mais je sens des problèmes de licence

De nombreux projets dans l'espace crypto utilisent également ce qui suit ( popularisé par le jargon des hackers de Bitcoin ):

  • Concept ACK - d'accord avec le concept, mais n'a pas examiné les changements
  • utACK (aka. ACK non testé) - accepte les modifications et les a examinées, mais n'a pas testé
  • Testé ACK - acceptez les changements, revu et testé

Ces réponses font généralement partie du processus de révision du code et vous les trouverez dans les problèmes ou les demandes d'extraction dans Github.

Mention honorifique: +1 comme forme abrégée d'ACK (et dans de nombreux cas, Concept ACK). Après la fameuse lettre «Cher Github», la plateforme a introduit des réactions appropriées pour désencombrer les commentaires. Non, il ne s'agit pas de faire de Github votre prochain Facebook :)

Vous verriez également les ACKs être inclus dans les messages de commit, comme comment le noyau Linux le fait depuis que Git est utilisé:

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 

Consultez le guide «Comment faire entrer vos modifications dans le noyau Linux» pour une explication approfondie.

Des réponses courtes similaires sont largement utilisées en génie logiciel et dans la communauté open source car elles rendent la communication plus efficace.

Vous avez sûrement vu ce qui suit dans le code source - TODO, FIXME, XXX et NOTE - et vous vous demandez seulement ce que signifie XXX ?

Vous souhaitez voir beaucoup plus d'acronymes avec des explications et peut-être un peu d'histoire? Consultez le fichier Jargon. C'est la source définitive depuis 1975.

Bonus trivia : d'où vient ACK / NACK?

Je dirais que cela vient des protocoles réseau / d'interface, peut-être que la popularité de TCP a causé une utilisation généralisée.

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