Skip to content

docs: add emoji headings and a contributing guide - #18

Merged
setchy merged 4 commits into
mainfrom
docs/standardize-readme-heading-style
Oct 14, 2026
Merged

setchy merged 4 commits into
mainfrom
docs/standardize-readme-heading-style

Conversation

@setchy

@setchy setchy commented Oct 14, 2026

Copy link
Copy Markdown
Member

Part of the standardize-readme-and-contributing change.

What

New CONTRIBUTING.md — the ## Development section moves here verbatim (the npm test / npm run bundle commands, the test:live notes and the bundle note). Headings stay plain.

README.md — gains the approved emoji headings and a pointer to the new guide:

# 💠 Gitify for KDE Plasma
## 🚀 Install
### 🛍️ From the KDE Store
### 🧰 From source
### 🚫 Disable or uninstall
## 🤝 Contributing   <- new, links to CONTRIBUTING.md
## 📄 License

Notes

  • Contributor-only content (development/testing/bundling) no longer lives in the README.
  • The KDE Store badge and every install instruction are unchanged.
  • The ## 🤝 Contributing pointer is new: it was not in the original README, but the README now loses its only development section, so a pointer keeps the guide discoverable. Easy to drop if you would rather it not be there.
  • 💠 is the KDE brand emoji. 🛍️, 🧰 and 🚫 are one-off choices for sections outside the shared vocabulary.

Applies the organization's approved README heading emoji convention and
moves the development instructions into CONTRIBUTING.md.
Applies the revised heading convention: `#` stays plain, `##` and below carry one emoji.
@sonarqubecloud

Copy link
Copy Markdown

@setchy
setchy marked this pull request as ready for review October 14, 2026 12:14
@setchy
setchy requested a review from afonsojramos as a code owner October 14, 2026 12:14
@setchy
setchy merged commit a424c9e into main Oct 14, 2026
2 checks passed
@setchy
setchy deleted the docs/standardize-readme-heading-style branch October 14, 2026 12:14
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.

1 participant