This is an original planning guide. It is not a vendor manual, an official standard, or legal advice. Example addresses use documentation ranges. Review every command before you paste it.
What this hour is for
Writing Good Commit Messages and Versioning uses a change you already made in a repository you administer. You write the message as a sentence. You do not create a release, and you do not put a secret in the message.
Write the account, project, or repository you administer, the name of this change, and the time. A second change waits until this line has been read back.
The browser tool drafts text or reads a paste you already hold. It does not log in, it does not scan, and it does not apply.
192.0.2.10/24, gateway 192.0.2.1, 198.51.100.0/24, 203.0.113.0/24, and 2001:db8::/32 are documentation. example.com is a documentation name. A sample password is replaced.
The change you can finish
Apply nothing while you are writing the note. When the lab window opens, it is one change on the account named in the ticket. Read the draft, then the account, then decide.
Rollback is the previous file, the previous plan, or the lab resource you can delete because it was only a lab.
- Write the repository.
- Write one message for a change you can name.
- Write the version line as a proposal.
- Do not tag.
- Stop.
Mistakes that outlive the statement
Writing Good Commit Messages and Versioning goes wrong in a small set of ways. The list is here so the ticket can forbid them before the window.
- A release tagged during the reading.
- A secret in the message.
- A version bumped on a repository you do not own.
- Two unrelated changes in the message.
Decisions to write down
One decision for Writing Good Commit Messages and Versioning: The repository is yours. Nothing is tagged. No secret is in the message. One change is the window. And the version is a proposal.
Checks before you call it done
Confirm this before you call the change done: The message is written. Nothing was tagged. No secret is in the note. The version is labelled a proposal. And a second person can say the change. If one of those fails, stop.
# Commit note. Do not tag a release during the reading.
Before you leave the account
Writing Good Commit Messages and Versioning ends when the account in the note is the account in the ticket. If it is not, stop.
The draft stays a draft until a person has read the names in it. A generator does not log in, does not apply, and does not scan.
192.0.2.10/24, gateway 192.0.2.1, 198.51.100.0/24, 203.0.113.0/24, and 2001:db8::/32 are documentation. example.com is a documentation name. A sample password is replaced. It is not a password you keep. 10.0.0.0/16 is a sample prefix, not a network you publish unless you already use it.
prompt-for-this is a reminder that a secret is missing. It is not an access key, a token, or a password you save. An Azure secret draft may contain a sample password. Replace it. Do not file it.
One change is the window. If two things move and the result is wrong, you will not know which one did it.
If the same step fails twice, stop for the day. Restore the copy you took first.
A second person reads the account and the change aloud. If they cannot find them in the ticket, the note is not done.
This page is a planning guide. It is not a vendor manual, not an official standard, not legal advice, and not an audit opinion. You do not apply it against an account you do not administer.
Tools for this guide
These tools run in the browser on this site. They do not log into your machines.
Related pillar guides
More in this cluster
The pillar for this page, and the next published pages filed with it.