docs: contributor guide, privacy-safe issue templates, PR checklist#24
Draft
ohad6k wants to merge 1 commit into
Draft
docs: contributor guide, privacy-safe issue templates, PR checklist#24ohad6k wants to merge 1 commit into
ohad6k wants to merge 1 commit into
Conversation
Closes #16. CONTRIBUTING.md documents the real setup (stdlib-only core, unittest suite, requirements.lock only for the optional pro extra), the repo layout, what a good PR looks like, and the hard rules: verify before claiming, never publish an unrun command, minimal diffs, never widen the privacy surface quietly. The issue templates steer reporters away from pasting profiles, session transcripts, and local paths, and ask for version, OS, command, and redacted error text instead. Blank issues are disabled so every report goes through a template that carries the redaction warning. Every command in the guide was run on this machine: python -m unittest discover -s tests (396 tests, OK, 3 Windows symlink skips, Python 3.11.4), emulo.py --help, --dry-run --path, plugin --help, and mcp. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Closes #16.
Adds
CONTRIBUTING.md, two issue templates, an issue-template config, and a PR checklist.Because Emulo reads private session logs, both issue templates actively steer reporters away from pasting profile contents, transcripts, or machine paths, and ask for redacted error text instead.
Verified
python -m unittest discover -s testsbefore and after: 396 tests, OK, 3 skipped. Re-run mattered becausetest_plugin_manifests.pyrglobs the tree.emulo.py --helpandplugin --help.python emulo.py mcpanswered a realinitializeJSON-RPC request.Needs a human call
config.ymlsetsblank_issues_enabled: false, so every report goes through a template. That changes how issues get filed. Three contact links are provided as escape hatches.SECURITY.mdhas no reporting contact, so the guide says "private vulnerability reporting if enabled" rather than inventing an address. Worth adding a real contact.Written by an agent working in an isolated worktree, reviewed before push.