Make sure to squash all the commits into one when merging the approved PR (or a few if that makes more sense, e.g multiple tickets), and give a good commit message:
feature(dogs): added dogs to the game: <ticket ref>
Most important piece is the ticket ref, so you can look…
You are on your feature or bug branch, and are ready to get it merged. Great work! Now the real work begins.
You should (though not always!) have a relevant ticket/task for the feature or bug. If you don’t, consider making one. …
In every single repo, a sweeping, opinionated, minimally customizable linter/auto-formatter should be used.
The linter/auto-formater should run when you save the files you are editing, this needs to be setup in your editor, and is easiest to do nowadays in vscode. If you choose not to use vscode, you will need to spend time getting your editor to do this.
The linter should run in cicd and fail the build if there are any issues
Benefits of this:
For all repos, including the game, there is only one long-living branch: main. You typically should never be on this branch. Even when starting a new project/repo, it is best to make a branch off of main after the initial commit.
The two main branch types are Feature and Bug…