OSS maintainer polish: security, changelog, CI, architecture - #1
Merged
Merged
Conversation
A public 1.0.0 repo with no issues, templates, or changelog looks abandoned. These files and the tag-based zip workflow make CheckUsage look like a real, trusted Mac tool without inventing users or touching provider auth. Co-authored-by: Nikita <sysrootix@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR is maintainer hygiene for a public 1.0.0 macOS tool: community trust docs, changelog, architecture map, issue/PR templates, CI/release automation, stronger offline fixtures, and Settings → About links. It does not invent stars or users, add telemetry, or change how provider sessions are read (Keychain / unofficial usage endpoints stay as-is).
Why
A shipped MIT app with one release, ad-hoc signing, and zero issues/PRs still looks unfinished to reviewers (including OSS-program applications). These files are what a real public Mac utility is expected to have. Provider auth is intentionally untouched.
What changed
Community / trust
SECURITY.md— private reports to sysrootix@gmail.com; in/out of scope (Keychain reuse and unofficial meters are not vulns by themselves; no token logging)CODE_OF_CONDUCT.md— Contributor Covenant 2.1CHANGELOG.md— Keep a Changelog,1.0.0(2026-08-29) plus Unreleaseddocs/ARCHITECTURE.md— App / Providers / UsageParsers / UsageService / UI / Settings, credential-read map, pointer to CONTRIBUTING for new providersconfig.yml) andPULL_REQUEST_TEMPLATE.mdCONTRIBUTING.md— PR checklist,make test/make app/make zip, branch naming, never commit secrets, how to cut a release (git tag v1.x.x && git push --tags)README
CI / release
ci.yml: concurrency cancel-in-progress, Homebrew cache,macos-15, Makefile still the source of truth, artifact upload only onmainrelease.yml: onv*tags,make zipand attachCheckUsage.app.zip(create the GitHub Release if missing)ziptarget (ditto, macOS-only, same asapp)Tests (no network)
individualUsage+ millis cycle, Copilot entitlement / chat / unlimited completions)Product (low-risk)
CFBundleShortVersionString; now viaAppInfoplus clickable GitHub / Issues / License links (localized in all ExtraL10n tables)Verification
YAML for both workflows parses. This cloud agent is Linux, so
make test/make appcannot runxcodebuildhere. macos-15 CI on this PR is the compile/test gate.Out of scope / deferred
How to release after this lands