-
Book Overview & Buying
-
Table Of Contents
The Platform Engineer's Handbook
By :
Once the repository setup decisions are made, you need to start looking into the specific conventions you will use for committing the code. Start by defining the structure of the commits (say, what information is required in a commit message) and then include the types of commits—whether they are a new feature, bug fix, documentation, refactoring, test-related, and so on. Also, tag the commits to make sure you can easily find those commits later, irrespective of the tracking tool you are using. One benefit is the idea of setting up pre-commit hooks to validate the commit message. You should use any tools you are already using for interactive activities around it, as well as linting and running quick tests to validate them. The more developers contributing to the platform code, the more you can make hooks a mandatory part of their workflow.
Commit conventions and policy automation aren't just rules for the sake of rules — they...