From 3c97eab3199e1549290dbbcf5192498d5bd743e5 Mon Sep 17 00:00:00 2001 From: przemyslawbialon Date: Fri, 24 Apr 2026 17:49:46 +0200 Subject: [PATCH] docs: Link GitHub Discussions from README + document category layout (#48) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Discussions have been enabled and seeded with three threads: - #72 Q&A: W-8BEN dividends - #73 Broker support: broker voting - #74 Announcements: welcome Changes: - README.md / README.pl.md: add "Community" footer section linking to Discussions and Issues — makes the tracker split visible at first glance - .github/DISCUSSIONS.md: new, documents category layout and posting conventions so a future maintainer can reconstitute the space or understand the decision to hide default categories (Ideas/Polls/etc.) Closes #48. --- .github/DISCUSSIONS.md | 41 +++++++++++++++++++++++++++++++++++++++++ README.md | 5 +++++ README.pl.md | 5 +++++ 3 files changed, 51 insertions(+) create mode 100644 .github/DISCUSSIONS.md diff --git a/.github/DISCUSSIONS.md b/.github/DISCUSSIONS.md new file mode 100644 index 0000000..c9204ef --- /dev/null +++ b/.github/DISCUSSIONS.md @@ -0,0 +1,41 @@ +# GitHub Discussions setup + +This document captures the category layout and seed threads created for +pit-38 Discussions. Future maintainers can use it to reconstitute the +space if needed, or to understand the rationale behind the category split. + +## Categories + +| Category | Format | Purpose | +|----------|--------|---------| +| **Announcements** 📣 | Announcement (maintainer-only) | Release notes, tax-law updates, breaking changes | +| **Q&A** 🙏 | Question + marked answer | Tax-rule interpretation questions where there's a definite answer | +| **Broker support** 🏦 | Open-ended | Broker requests, sanitized CSV samples, discussion of quirks | + +Other default categories (General, Ideas, Polls, Show and tell) are +hidden — we want a focused, low-cognitive-load surface. If traffic grows, +re-enabling them is trivial in Settings → Discussions. + +## Seed threads + +| # | Category | Title | +|---|----------|-------| +| [#72](https://github.com/pbialon/pit-38/discussions/72) | Q&A | How do I handle W-8BEN dividends in PIT-38? | +| [#73](https://github.com/pbialon/pit-38/discussions/73) | Broker support | Which broker should we support next? | +| [#74](https://github.com/pbialon/pit-38/discussions/74) | Announcements | Welcome to pit-38 Discussions | + +## Posting conventions + +- **Language**: Polish and English both welcome. Maintainers respond in + the language of the thread. Use `[PL]` prefix in title if Polish-only. +- **Announcements**: maintainer-only by category configuration. +- **Broker support**: encourage sanitized CSV snippets (5–10 rows max, + PII removed) rather than full exports. See issue #33 for an example + of how real exports informed the BOM/locale fixes. +- **Q&A**: maintainers can mark the accepted answer to boost future + searchability — we're using Discussions partly as a knowledge base. + +## Links + +- [Discussions landing](https://github.com/pbialon/pit-38/discussions) +- [Closing issue](https://github.com/pbialon/pit-38/issues/48) diff --git a/README.md b/README.md index a980f71..416fd3d 100644 --- a/README.md +++ b/README.md @@ -97,6 +97,11 @@ pytest tests/ This tool is provided for **informational purposes only** and does not constitute tax advice. Always verify your calculations with a qualified tax advisor before filing your PIT-38 declaration. +## Community + +- **[GitHub Discussions](https://github.com/pbialon/pit-38/discussions)** — tax-rule Q&A, broker requests, feedback. English and Polish both welcome. +- **[Issue tracker](https://github.com/pbialon/pit-38/issues)** — bug reports and feature requests. + --- Buy Me A Coffee diff --git a/README.pl.md b/README.pl.md index 99891ca..e7e3169 100644 --- a/README.pl.md +++ b/README.pl.md @@ -97,6 +97,11 @@ pytest tests/ To narzędzie służy wyłącznie **celom informacyjnym** i nie stanowi porady podatkowej. Przed złożeniem deklaracji PIT-38 zweryfikuj obliczenia z doradcą podatkowym. +## Społeczność + +- **[GitHub Discussions](https://github.com/pbialon/pit-38/discussions)** — pytania o zasady podatkowe, prośby o wsparcie nowych brokerów, feedback. Po polsku i angielsku. +- **[Issue tracker](https://github.com/pbialon/pit-38/issues)** — zgłoszenia błędów i propozycje funkcji. + --- Buy Me A Coffee