docs: refresh CONTRIBUTING + add issue/PR templates - #21
Merged
Conversation
- CONTRIBUTING.md updates:
* Test-count line dropped its hard-coded "67 unit + 1 e2e" (was wrong;
suite is now 513+) in favor of a description of what each command
runs.
* "four protocols" → "nine protocols" everywhere it appeared. The
async-everywhere convention now lists the I/O-bound protocols
explicitly so newcomers know Chunker/CitationRenderer stay sync
on purpose.
* "Adding a new Source / Index / Embedder / CitationRenderer" expanded
to a 9-row table covering every protocol with its package path,
and the steps now name `tests/conftest.py` real fakes explicitly.
- .github/ISSUE_TEMPLATE/ added:
* bug_report.yml — structured fields for repro, env, logs.
* feature_request.yml — problem-first framing, scope dropdown.
* config.yml — disables blank issues, routes usage questions to
Discussions and existing roadmap/good-first-issue queries.
- .github/pull_request_template.md added — matches the "Test plan"
convention CONTRIBUTING.md already requires. Comment block reminds
contributors of the branching + squash-merge rules without being
preachy in the rendered PR body.
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.
Summary
Newcomer-facing polish so outside contributors hit fewer paper cuts.
CONTRIBUTING.md correctness fixes
Issue templates (
.github/ISSUE_TEMPLATE/)PR template (
.github/pull_request_template.md) — matches CONTRIBUTING's existing "Test plan" convention so reviewers see consistent PR bodies.Closed #5 separately — it was shipped in #12 and would have wasted a newcomer's time.
Test plan