Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update, mostly for AppImage notes #639

Merged
merged 2 commits into from
May 31, 2024
Merged

Conversation

GitMensch
Copy link
Contributor

@GitMensch GitMensch commented May 15, 2024

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
Copy link
Contributor

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

@lievenhey lievenhey requested a review from milianw May 16, 2024 11:25
@GitMensch
Copy link
Contributor Author

Wouldn't docs be more appropriate?

@lievenhey
Copy link
Contributor

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 GitMensch force-pushed the patch-1 branch 2 times, most recently from 00635bb to 09b0a4d Compare May 17, 2024 06:38
@GitMensch GitMensch changed the title Update README.md docs: update, mostly for AppImage notes May 17, 2024
* add license information
* add conventional commits convention
@GitMensch
Copy link
Contributor Author

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?

Copy link
Member

@milianw milianw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

HACKING.md Outdated Show resolved Hide resolved
@GitMensch
Copy link
Contributor Author

GitMensch commented May 17, 2024 via email

@lievenhey
Copy link
Contributor

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

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
@GitMensch
Copy link
Contributor Author

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.

@milianw milianw merged commit 0131bbd into KDAB:master May 31, 2024
13 checks passed
@GitMensch GitMensch deleted the patch-1 branch May 31, 2024 17:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants