Skip to content

docs: fix grammatical and readability problems README.md - #1017

Open
xHope-tech wants to merge 7 commits into
projectbluefin:mainfrom
xHope-tech:docs-fixed-grammatical-problems-README.md
Open

docs: fix grammatical and readability problems README.md#1017
xHope-tech wants to merge 7 commits into
projectbluefin:mainfrom
xHope-tech:docs-fixed-grammatical-problems-README.md

Conversation

@xHope-tech

@xHope-tech xHope-tech commented Aug 21, 2026

Copy link
Copy Markdown

bluefin-common PR

What does this change?

Fix grammatical and readability problems README.md. Under ### system_files/bluefin/ - Bluefin Specific Configuration. Correct capitalization of 'Flatpak' in multiple sections of the README. Add missing periods (.) in multiple sections of the README.md.

Why?

Fix grammatical and readability problems README.md. Under ### system_files/bluefin/ - Bluefin Specific Configuration. Correct capitalization of 'Flatpak' in multiple sections of the README. Add missing periods (.) in multiple sections of the README.md.

Closes #

PR pipeline

opened ──▶ 4-review ──▶ approved ──▶ merged

A maintainer reviews and approves; merge goes through the merge queue.
Select blocked or hold to pause the work.

Checklist

  • PR title follows Conventional Commits (fix:, feat:, docs:, ci:, refactor:, etc.)
  • just check passes
  • pre-commit run --all-files passes
  • Skill doc updated if the change affects agent-facing conventions or behavior (see docs/skills/skill-improvement.md)
  • AGENTS.md / docs/SKILL.md / docs/skills/ links remain valid
  • CI is green after push: gh run list --repo projectbluefin/common --limit 5

AI attribution

If this PR includes AI-authored commits, include both trailers:

Assisted-by: <Model> via GitHub Copilot
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Corrected capitalization of 'Flatpak' in multiple sections of the README.
…fic Configuration


Add missing ":" under ### system_files/bluefin/ - Bluefin Specific Configuration:

"Files specific to Bluefin"
Corrected punctuation by adding periods to list items in the README.

docs: add missing periods (.) in README.md.
@xHope-tech
xHope-tech requested review from a team and repires as code owners August 21, 2026 19:57

@hanthor hanthor left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Read the full diff — purely cosmetic README prose fixes: capitalizing "Flatpak" consistently and adding missing trailing periods to bullet-list items throughout. No links, code, commands, or documented behavior changed, and no line's meaning shifted. Single file (README.md).

No CI has run yet (likely pending a maintainer's one-time workflow-run approval for a first-time external contributor), but that's not a blocker here — the checks that exist (validate.yml, build.yml, skill-drift.yml, pr-e2e.yml) test shell/build/image behavior, none of which this PR touches.


Generated by Claude Code

@castrojo
castrojo enabled auto-merge August 25, 2026 15:38
@kubestellar-hive kubestellar-hive Bot added the lgtm This PR has been approved by a maintainer label Sep 7, 2026

@kubestellar-hive kubestellar-hive Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Approved by @castrojo for Hive auto-merge on green CI.

@hanthor hanthor left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Reads clean and merges clean — one factual nit you could fix while you're in here

Verified against current main: merges without conflict, README-only (38 insertions / 38 deletions, no other file), so nothing under system_files/ and no bluefin / bluefin-lts / dakota blast radius. The flatpakFlatpak capitalisation is right — it is a proper noun, and the repo was inconsistent about it.

Nit, pre-existing and not introduced by you. Two lines you are already touching make a count claim that is now off by one:

- **`system-flatpaks.Brewfile`** - Core Flatpaks installed on all Bluefin variants (37 applications ...
$ grep -cE '^[[:space:]]*flatpak ' system_files/bluefin/usr/share/ublue-os/homebrew/system-flatpaks.Brewfile
38
$ grep -cE '^[[:space:]]*flatpak ' system_files/bluefin/usr/share/ublue-os/homebrew/system-dx-flatpaks.Brewfile
6

The DX count (6) is still correct; the core count is 38, not 37. Since your diff already rewrites that exact line, bumping 3738 is a free fix. Worth considering dropping the hardcoded number entirely — it is guaranteed to drift again and nothing in CI checks it.

Second nit on the same line, also pre-existing: it says "installed on all Bluefin variants", but the file lives under system_files/bluefin/, not system_files/shared/, so it does not reach bluefin-lts or dakota. "on Bluefin" would be more accurate. Your call whether that is in scope for a grammar pass.

On the checklist: just check and pre-commit run --all-files are unticked. Neither can be affected by a README-only change (just check only formats *.just and the Justfile), so that is not a real gap — but note there are currently zero reported checks on head 90c6a567:

$ pull_request_read get_status 1017
{"state":"pending","sha":"90c6a567...","total_count":0,"statuses":[]}

mergeable_state is blocked, so this is waiting on a maintainer review plus a check actually reporting, not on anything in the diff.


Generated by Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm This PR has been approved by a maintainer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants