docs: update, mostly for AppImage notes

KDAB / hotspot

The Linux perf GUI for performance analysis.

4.16k stars 257 forks source link

docs: update, mostly for AppImage notes #639

Closed GitMensch closed 5 months ago

GitMensch commented 6 months ago

CONTRIBUTING.md:

add license information
add conventional commits convention

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
replace shown version string by a clear pseudo-version
update shown dates to a more current one

lievenhey commented 6 months ago

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

GitMensch commented 6 months ago

Wouldn't docs be more appropriate?

lievenhey commented 6 months ago

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.

GitMensch commented 6 months ago

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 commented 6 months ago

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: @.***>

lievenhey commented 6 months ago

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

GitMensch commented 6 months ago

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.