Repository navigation
feat(outreach): issue-first README outreach, on by default, every send tracked (ADR-0015) - #31
Merged
Merged
Conversation
…link under title) and the PR text + who-to-send-to rules Not yet wired into the readme-enhance station; channel (PR vs issue-first) pending the owner's decision.
…a yes, every send tracked (ADR-0015) - the station sends one friendly issue with the rendered README, images and explainer link - additions only; ASCII diagrams become animated SVGs above the originals - never own/private repos, one contact per repo, daily cap, a closed item is never re-sent - ledger + 'explainmyrepo outreach status | open-pr'; --no-readme-pr / README_ENHANCE=0 to disable
✅ Deploy Preview for explainmyrepo canceled.
|
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
1 participant
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.
What
The owner's brief: always send the maintainer a friendly, visual README suggestion in the tone of the claude-swap PR, with the new per-repo graphics, and track whether people respond. They also asked for a review of the channel because they don't want to be a bad citizen. ADR-0015 records the decision and the evidence.
Decision (owner picked option 1 of 3)
Issue first, PR on a yes. On claude-swap,
ghshows 143 open PRs (3 new a day) and a maintainer-approval workflow on our PR; an issue carries the finished work (rendered README in one click, images, explainer link) and asks nothing of them. The PR is a second, human-triggered step:explainmyrepo outreach open-pr owner/name.What changed
tools/readme-enhance.mjsrewritten: on by default, issue channel, optional PR channel, dry-run mode.src/readme-ascii.mjs: additions-only README rewrite; ASCII diagrams → animated SVG twins.src/readme-pr.mjs: the message (tone, README-link-first, images) + who is skipped.src/outreach.mjs/outreach-cli.mjs: ledger, daily cap, one-contact-per-repo,outreach status.--no-readme-pr, an OUTREACH section in--help.Rules enforced in code (each proven by deleting it and watching a test fail)
never your own repo or a private repo · one contact per repo, ever · a closed/merged item is never re-sent · daily cap (5) · additions only · no preview hosted → no issue
Evidence
Not claimed
npx explainmyrepocontacts maintainers from their own account, rate-limited and one flag from off. That is a real decision; it is in the ADR.