search

getsolus / help-center-docs

Solus's Help Center documentation as well as previous User Guide.
https://help.getsol.us
GNU General Public License v2.0
56 stars 84 forks source link

new package: Update example to subject: verb version #496

Closed ermo closed 5 months ago

ermo commented 5 months ago

Description

With the monorepo, we use the worklog.py script and the GH UI, which shows the git summary for each commit at a glance.

Therefore, the git summaries in commits should be as informative as possible so people don't have to go chasing the individual commit logs for relevant version information when looking for specific updates or summarising the weekly development churn in the forum sync notes.

This PR changes the old (and no longer useful) "Initial inclusion" git summary part of the commit message to a more useful "packagename: Add at version" summary.

Note that we already require "packagename: Update to version" for the same reason. This PR also expands on this by adding a section with other useful git summary commit message examples related to common package update scenarios.

TraceyC77 commented 5 months ago

I agree with David's points.

ermo commented 5 months ago

@davidjharder , @TraceyC77 , @EbonJaeger

Thank you all for your (excellent!) suggestions.

I've essentially achieved what I wanted with this, which is to shine a light on how the workflow and examples we show new (and returning) packagers will help make the monorepo commit shortlogs more useful to packagers (including Solus Staff) overall.

I have my hands full with Serpent now coming properly online and simply can't afford to give this the copy-editing time it needs in order to be of high enough quality to meet your standards AND be easy to read.

Therefore, I am of the opinion that this really ought to be taken over by the comms/doc team, as you are clearly better at judging what users need here?

Feel free to close this and use it as a basis for a better worded PR?

EDIT: As a show of good faith, I'm giving this a final cycle where I address the review comments to the best of my ability. After that, I nominate @EbonJaeger to drive it over the finish line so it ends up in the best possible place for users and Solus as a project alike.