Skip to content

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

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

setchy merged 5 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 and ## Releasing sections move here verbatim (the pnpm workflow, the nested-shell instructions, the docs/testing.md pointer and the release-please flow). Headings stay plain.

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

# 🐾 Gitify GNOME Shell extension
## 📋 Requirements
## 🚀 Install
### 🌐 From extensions.gnome.org
### 🎁 From a release bundle
## 🔧 How it works
## 🤝 Contributing   <- new, links to CONTRIBUTING.md
## 👏 Credits
## 📄 License

Notes

  • Contributor-only content no longer lives in the README; the README keeps the product description, requirements, install steps, how-it-works and credits.
  • All install links, the extensions.gnome.org links and the requirements text are unchanged.
  • 🔧 is used for "How it works" because the approved vocabulary maps Usage/How it works to 🔧. 📋 Requirements and 🚀 Install are kept distinct so no emoji is reused for two roles in one document. 🐾 is the GNOME brand emoji.
  • Devin/CI config is untouched.

Applies the organization's approved README heading emoji convention and
moves the development and release instructions into CONTRIBUTING.md.
Applies the revised heading convention: `#` stays plain, `##` and below carry one emoji.
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:15
@setchy
setchy requested a review from afonsojramos as a code owner October 14, 2026 12:15
@setchy
setchy merged commit 222ec6d into main Oct 14, 2026
8 checks passed
@setchy
setchy deleted the docs/standardize-readme-heading-style branch October 14, 2026 12:15
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