Engineering Practices

How work is proposed, written, reviewed and recorded.

• An issue first. The issue is where the problem is stated and agreed. See Branches and pull requests.
• A covering test before a risky change, and the narrowest edit that does the job.
• Measure, then record. A number in the documentation is read off a run, with the date and the commit, not derived from an older number.
• Say what was not verified. A pull request states what was run and what was not.
• Errors name the problem. A bare exception becomes “Operation failed” by the time an editor sees it. Return an error the caller can act on.

Further pages:

• Commit messages
• AI-assisted development