{"thread":{"id":"53561","subject":"Bug report: Parameters for the `prepare-commit-msg` hook could use better documentation.","startedAt":"2020-05-26T23:43:39Z","lastAt":"2020-05-26T23:43:39Z","messageCount":1,"participants":["Dan Rose"],"isPatch":false,"patchVersion":null,"patchTotal":null},"messages":[{"id":"398606","messageId":"CAJGDnb1eXBQtoAtGu6u7atmrHTbmtcBzuZpOixr2EWsLjD1SiA@mail.gmail.com","threadId":"53561","inReplyTo":null,"subject":"Bug report: Parameters for the `prepare-commit-msg` hook could use better documentation.","fromName":"Dan Rose","fromEmail":"dan@digilabs.io","sentAt":"2020-05-26T23:43:00Z","receivedAt":"2020-05-26T23:43:39Z","isPatch":false,"sender":{"key":"dan@digilabs.io","avatar":null},"body":"Bug report: Parameters for the `prepare-commit-msg` hook could use\nbetter documentation.\n\n1. It's not clear under which circumstances the number of parameters\nvaries (e.g. \"When there is no initial commit message text, the hook\ngets one parameter. When the commit message is derived from another\ncommit, the hook gets three parameters. In all other cases, the hook\ngets two parameters)\n2. It is hard to tell what third parameter's relation to the preceding\nlist of commit message sources. Replacing the list with just the third\nitem shows that, grammatically, the documentation says the SHA-1 is\npart of the second parameter: \"The second is the source of the commit\nmessage, and can be ... commit, followed by a commit SHA-1 (if a -c,\n-C or --amend option was given).\"\n3. The types of values the third parameter can take include \"HEAD\", an\nunambiguous sha-1 prefix, or seemingly any type of commit reference.\nThis is not documented.\n"}]}