jonyo
commented
2 years ago @vicos59 Looks good!
For the PR title can you change it to say what was done? Put the fixes ### in the description, and that will make github automatically close that issue for you. But it makes things easier for posterity if you give a title on the PR. It can even match the title of the issue (if it applies).
That is because the release log uses the PR titles as the bullet points, it makes the release notes much more useful that way.
And the same for commit messages, for different reason:
It is fine this time, but for the future: on commit messages, be sure to put a descriptive sentence of what changed. The reason I say that is imagine looking at the history log because maybe you are trying to see when something was done, or find out why something was done, or whatever...
Imagine in the history it is a bunch of things like
- Fixes #8881389223
- Partial commit
(side note: people tend to do this starting out a lot, but it is another one that results in un-useful git history) - Fixes #1449212384
etc.
Vs somewhat short sentences:
- Update links to use new .org domain
- Change branding wording to say community edition instead of older LLC
- Fix weird whitespace etc.
The rule of thumb I use on commits is to make a short sentence saying what it is. If you find yourself saying "and ..." or having to list a bunch of things, sometimes it is better to break it up into multiple commits. (One PR that has multiple commits because there are multiple things being changed). Basically organize the commits so you can write one sentence about it. Don't make it one line change per commit or something lol, group them, but all the changes should be doing a single thing, if that makes sense.
Fixes #113