chore: repo readiness — badges, templates, CONTRIBUTING, CoC, version placeholder#11
Merged
Conversation
… placeholder
Bundles the OSS-readiness audit findings:
README:
- Add badges row above the tagline (npm version, downloads/wk, license,
CI status, npm provenance) — visible trust signals above the fold
- Strike already-shipped Roadmap items (Wayland, fs.watch migration,
Vitest, localized macOS filenames, spawnSync hardening) and reframe
as 'Already shipped' so visitors see what's done vs pending
- Add Aider to the AI-agent name-drops in the lead paragraph
package.json:
- description now says 'macOS · Linux (X11 & Wayland) · Windows · WSL'
(was missing Wayland — npm registry's description was stale)
- version pinned at '0.0.0-managed-by-semantic-release' as a deliberate
placeholder. semantic-release rewrites the real version into the
workspace at publish time; the file on master honestly signals
'authority lives in the npm registry / git tags, not here'. Avoids
having to set up a write-permission token for sr to push version
bumps back through branch protection
- keywords: drop low-intent ('tailscale', 'monitor', 'darwin'), add
high-intent ('aider', 'wayland', 'ai-agents', 'ssh-tunnel',
'screenshot-tool', 'cli', 'pngpaste', 'remote-development')
GH community files:
- .github/ISSUE_TEMPLATE/bug.yml: structured form prompting for
sshshot version, OS, Node, ssh-config presence, log tail
- .github/ISSUE_TEMPLATE/feature.yml: light template
- .github/ISSUE_TEMPLATE/config.yml: blank issues disabled, contact
links to Discussions + private security advisory
- .github/PULL_REQUEST_TEMPLATE.md: documents Conventional Commits
+ squash-merge-uses-PR-title so first-time contributors don't
hit pr-title-lint blind
- CONTRIBUTING.md: setup, branch/PR conventions, sr release rules,
signed-commit requirement, where to file security issues
- CODE_OF_CONDUCT.md: Contributor Covenant 2.1 verbatim with
enforcement contact pointing at the GitHub Security Advisory flow
GH repo settings (via gh api, not in this commit):
- Discussions enabled
- Topics retuned: dropped 'anthropic'/'openai' (low-intent for a CLI
that works with any agent), added 'aider', 'wayland', 'ssh-tunnel',
'dev-tools', 'ai-agents', 'screenshot-tool'
|
🎉 This PR is included in version 0.7.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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.
Round A of the OSS-readiness audit. No release expected (
chore:doesn't trigger semantic-release).What
versionpinned at0.0.0-managed-by-semantic-releaseas a deliberate placeholder (npm registry + git tags are the version source; semantic-release rewrites this in CI before publish).descriptionupdated to mention Wayland.keywordsretuned for npm search discovery.gh api)