keybase-gpg-github
keybase-gpg-github copied to clipboard
Examples should be with placeholders
Sometimes people just copy/paste examples/documentation. Maybe is better to put a note or a placeholder.
Example:
$ git config --global user.signingkey [KEY-ID-HERE]
$ git config --global commit.gpgsign true
I'm not sure whether this would make it more complicated.
Why not just leverage environmental variables where it would be the most helpful, like long output, and have a setup script that simply exports them. That way the examples can just look like this.
Example:
$ # assuming you exported the variables from before…
$ git config --global user.signingkey $KEY_ID_HERE
$ git config --global commit.gpgsign true
That would make more sense, PRs welcome.