hotspot icon indicating copy to clipboard operation
hotspot copied to clipboard

docs: update, mostly for AppImage notes

Open GitMensch opened this issue 1 year ago • 5 comments
trafficstars

README.md:

  • updated AppImage notes - point to latest/continuous release instead of CI artifacts
  • case adjustments for Hotspot and AppImage
  • http -> https
  • some minor rewording

HACKING.md:

  • drop the unzip step as it is not needed any more
  • update AppImage version and date to a more current one

GitMensch avatar May 15 '24 16:05 GitMensch

we are now using conventional commits. Please prefix your commit message with chore:

lievenhey avatar May 16 '24 11:05 lievenhey

Wouldn't docs be more appropriate?

GitMensch avatar May 16 '24 13:05 GitMensch

Sure, its just that the conventional commits documentation is weird (at least what I found) so I am not sure which tags actually exists. I knew of fix, feat, chore, test and ci.

lievenhey avatar May 16 '24 13:05 lievenhey

Added a second commit for the conventional commits (I've totally missed that) in CONTRIBUTING.md and also updated the HACKING file. Note that Markdownlint is wrong - dropping the double whitespace will lead to the text being all on one line (the formatting rule was always two spaces and a line break means a line break). Should we still pull this or use "one long rendered line" or "adding a paraghraph for each sentence?

GitMensch avatar May 17 '24 06:05 GitMensch

I wanted to use a newer version and date as this makes the document look less outdated to me. If you want to I'll only update the 1.3 one to the 1.4 (to make samples use the same) and don't change the date.

Am 17. Mai 2024 09:44:09 MESZ schrieb Milian Wolff @.***>:

@milianw commented on this pull request.

why the changes to the version + sha? that's just an example

$ tar -xvf hotspot-debuginfo-*.tar.bz2 -hotspot-debuginfo-v1.4.0-43-g02fd82c/usr/bin/hotspot -hotspot-debuginfo-v1.4.0-43-g02fd82c/usr/lib64/libexec/hotspot-perfparser +hotspot-debuginfo-v1.5.0-17-g0ed41cf/usr/bin/hotspot

here and below. unrelated changes?

-- Reply to this email directly or view it on GitHub: https://github.com/KDAB/hotspot/pull/639#pullrequestreview-2062564354 You are receiving this because you authored the thread.

Message ID: @.***>

GitMensch avatar May 17 '24 07:05 GitMensch

@GitMensch can you rebase this patch please. Master contains a patch that should stop pre-commit from complaining about that formatting.

lievenhey avatar May 24 '24 07:05 lievenhey

Done. To care for @milianw's comments I've also used the previous SHA in the version numbers referenced (less changes) and changed the version number itself top a clear pseudo-version so it won't be likely for any one to feel the need to update them.

GitMensch avatar May 24 '24 08:05 GitMensch