Skip to content

docs: OSS adoption upgrade#1

Merged
solomonneas merged 1 commit into
mainfrom
docs/adoption-upgrade
Jun 26, 2026
Merged

docs: OSS adoption upgrade#1
solomonneas merged 1 commit into
mainfrom
docs/adoption-upgrade

Conversation

@solomonneas

Copy link
Copy Markdown
Collaborator

Brings agent-notify up to the Escoffier OSS adoption standard. Docs and repo metadata only; no source, build, or manifest changes.

Changes

README

  • Opens with what / why / how-it-differs in the first three sentences, with the differentiator (no telemetry, no vendor push service) on the first screen.
  • Centered title, bold one-liner, centered shields.io badge row (CI, release, Go version, MIT license), and a prominent Website link to https://agent-notify.escoffierlabs.dev (verified HTTP 200).
  • New keyword-rich ## What it does section with the primary keyword in the first 100 words.
  • New ## Verify the wiring section with real, verified doctor and status output captured from the built binary in an isolated environment (no fabricated output).
  • New ## Why not <alternatives>? and ## What agent-notify is not sections.
  • Preserves all accurate existing content (install, quickstart, routing, hook integrations, exit codes, channel formatting, limitations).

Maintainer-health files (new)

  • SECURITY.md - private report path, trust model, in/out-of-scope.
  • CONTRIBUTING.md - contribution scope, channel/hook adapter guides, no-telemetry invariant.
  • CODE_OF_CONDUCT.md - Contributor Covenant 2.1.
  • .github/ISSUE_TEMPLATE/{bug.yml,feature.yml,config.yml} - blank_issues_enabled: false with website + security contact links.
  • .github/PULL_REQUEST_TEMPLATE.md - includes a no-PII / content-guard checkbox.
  • CHANGELOG.md - Keep a Changelog format with an Unreleased entry plus the released versions.

Repo metadata (via gh, additive)

  • Description and homepage confirmed; added topics codex, privacy, webhook.

Checklist

  • Website link re-verified (HTTP 200)
  • content-guard scan clean on every changed/new file; pre-push hook passed
  • Real-output blocks are verified, not fabricated
  • Example IPs use 192.0.2.x; no home paths, hostnames, or real private IPs
  • Conventional commit, no AI co-authorship trailer
  • No source / build / manifest changes
  • Do not merge or cut a release in this PR

Please review with Codex only (no CodeRabbit / no bots).

Restructure README to lead with what/why/how-it-differs, add a centered
title and badge row, a prominent Website link, a keyword-rich 'What it
does' section, verified doctor/status output blocks, and 'Why not
<alternatives>?' plus 'What agent-notify is not' sections.

Add maintainer-health files: SECURITY.md, CONTRIBUTING.md,
CODE_OF_CONDUCT.md, GitHub issue templates (bug, feature, config with
blank issues disabled and contact links), a pull request template with a
no-PII checklist, and a CHANGELOG.md.
@solomonneas
solomonneas merged commit 2b0ff61 into main Jun 26, 2026
2 checks passed
@solomonneas
solomonneas deleted the docs/adoption-upgrade branch June 26, 2026 15:33
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