Make it easier to learn Arlo's Commit Notation by incorporating the guide into `git commit`

[alexbird-hunterindustries]

While learning the commit notation, it's helpful to have this guide open when authoring a commit message.

This PR provides instructions for how to configure git to use this guide as a commit message template so it's visible in the editor when running git commit.

https://github.com/RefactoringCombos/ArlosCommitNotation/assets/148801136/086b544d-3aa2-4aa4-bea4-ea5c768fb3dd

[JayBazuzi]

I like this idea but I worry about the duplication between this document and others. Got any ideas for fixing that?

[alexbird-hunterindustries]

I like this idea but I worry about the duplication between this document and others. Got any ideas for fixing that?

Hmm 🤔

On the one hand, since the main document changes so infrequently, it may be negligible. At some point V2 is published, and then I or someone else takes the time to create the new cheat sheet, and then we're good for the next few years.

But if we do want to deal with the duplication, here are some thoughts:

• the best case would be a polyglot document: it renders well as markdown for browsing on GitHub, and it can be used directly as the commit message template.
  • for the git template, the lines must all start with # so they're excluded from the commit message
  • I don't know of a way to render an HTML table without starting the line with |
• if we can't do a polyglot template, we could auto-generate the git message
  • a small script that takes the main markdown as an input, takes only the relevant lines, and outputs them to the git message file prefixed by #
    • whenever the main markdown is changed, we run the script and commit the output
  • this would be easier if the table could be a separate document that is linked to from the main markdown
    • but it's really nice to have the whole doc in one page, and splitting it into two pages hurts the readability of the main document
• the main markdown file and the git commit template are both generated by a script, and the main content lives in multiple markdown files
  • for the main document, the 3 source documents are concatenated (stuff before the table, the table, and stuff after the table).
  • for the commit template, the table is prefixed with # on each line

generate.sh

cat part1.md table.md part2.md > index.md
sed "s/^/# /" > .gitmessage