docs: Add bilingual issue templates and PR template (#47)#76
Merged
Conversation
Six Markdown issue templates (3 types × PL/EN) let reporters pick their preferred language from GitHub's "New issue" dropdown. The flag emoji in each template's `name:` makes the choice visually obvious. One shared `config.yml` disables blank issues and points tax-rule Q&A toward Discussions (opened in #48). Templates mirror each other across languages and include sections tailored to pit-38's domain: - bug_report_{en,pl}.md — environment, sanitized CSV snippet (with PII warning), expected vs actual output with encouragement to cite the ustawa article - feature_request_{en,pl}.md — user story in "Polish investor" form, motivation, scope/out-of-scope - broker_support_{en,pl}.md — broker name/region, asset class, sanitized sample, operation types observed, "known quirks" (BOM, locale, sign position) directly informed by #33's lessons config.yml: - blank_issues_enabled: false → force template selection - three contact links: Q&A in EN + PL, Broker support discussion PULL_REQUEST_TEMPLATE.md (English, with a note inviting PL comments because contributors are increasingly international): - Summary + Closes # - Tax-correctness impact (bespoke — pit-38's most important review gate) - Testing checklist - Documentation checklist (TAX_RULES.md, CHANGELOG, TAX_LAW_AUDIT) Also adds the `broker-support` label so broker-request issues are auto-tagged. Closes #47.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
2 participants
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 #47. Second of three remaining items in the Community-ready milestone (due 2026-04-28).
What's new
Six issue templates (3 types × PL/EN) — GitHub shows them as a dropdown when users click "New issue":
bug_report_en.mdbugbug_report_pl.mdbugfeature_request_en.mdenhancementfeature_request_pl.mdenhancementbroker_support_en.mdbroker-support,help wantedbroker_support_pl.mdbroker-support,help wantedPlus
config.yml(blank issues disabled, 3 contact links to Discussions) andPULL_REQUEST_TEMPLATE.md(EN, contributor-facing).Added label:
broker-support(color #5319e7).Design notes
name:rather than separate folders. Users pick their language from dropdown, then template is fully in that language — no mixed content to edit.Acceptance criteria (#47)
.github/ISSUE_TEMPLATE/bug_report.md→ split into_en/_pl.github/ISSUE_TEMPLATE/feature_request.md→ same.github/ISSUE_TEMPLATE/broker_support_request.md→ same.github/ISSUE_TEMPLATE/config.yml(blank disabled, Discussions links).github/PULL_REQUEST_TEMPLATE.mdRelated