docs: OSS adoption upgrade#1
Merged
Merged
Conversation
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.
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.
Brings agent-notify up to the Escoffier OSS adoption standard. Docs and repo metadata only; no source, build, or manifest changes.
Changes
README
## What it doessection with the primary keyword in the first 100 words.## Verify the wiringsection with real, verifieddoctorandstatusoutput captured from the built binary in an isolated environment (no fabricated output).## Why not <alternatives>?and## What agent-notify is notsections.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: falsewith website + security contact links..github/PULL_REQUEST_TEMPLATE.md- includes a no-PII / content-guard checkbox.CHANGELOG.md- Keep a Changelog format with anUnreleasedentry plus the released versions.Repo metadata (via gh, additive)
codex,privacy,webhook.Checklist
content-guard scanclean on every changed/new file; pre-push hook passedPlease review with Codex only (no CodeRabbit / no bots).