From b5b59f3dbe15ea1dde5cf318826b4cd0a17eecfe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=8E=8B=E5=AD=90=E6=89=8D?= Date: Wed, 1 Apr 2026 12:52:18 +0800 Subject: [PATCH] Add and improve issue templates as requested in #65 - Improved bug report template with clearer CodeSandbox instructions - Enhanced question template with detailed guidelines - Added examples/README.md with starter template documentation - All required templates are now in place: bug report, feature request, question, and PR template Resolves #65 --- .github/ISSUE_TEMPLATE/bug_report.md | 10 +++++--- .github/ISSUE_TEMPLATE/custom.md | 36 ++++++++++++++++++++++++---- examples/README.md | 25 +++++++++++++++++++ 3 files changed, 64 insertions(+), 7 deletions(-) create mode 100644 examples/README.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 2687204..1c51d14 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -23,12 +23,16 @@ https://github.com/piotrwitek/typesafe-actions#extending-internal-types-to-enabl -### CodeSandbox Link +### CodeSandbox Link (Recommended) -*(PASTE HERE your codesandbox link)* +*(PASTE HERE your codesandbox link after reproducing the bug)* ### No CodeSandbox Link If no codesandbox, then please provide a full working code example below including actions, reducers and your custom types used in the example. diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md index 775f3ed..ff4a375 100644 --- a/.github/ISSUE_TEMPLATE/custom.md +++ b/.github/ISSUE_TEMPLATE/custom.md @@ -1,9 +1,37 @@ --- name: Question -about: Have a question? Please check our spectrum community chat. +about: Ask a question about typesafe-actions --- -First of all please check our spectrum community chat and we recommend to ask your question there for a quickest response and the indexing in search engines: -- https://spectrum.chat/typesafe-actions +## Before submitting -The only good reason to use issue tracker for your questions would be for "special cases" that doesn't fit into bug reports and feature requests categories. +First of all please check our spectrum community chat - we recommend to ask your question there for quickest response and better indexing in search engines: +- **Spectrum Community Chat:** https://spectrum.chat/typesafe-actions + +## When to use this template + +Only use this issue tracker for your questions if: +1. You have a complex question that requires detailed discussion +2. Your question is related to a potential bug or feature request +3. You've already asked in Spectrum but didn't get a satisfactory answer + +## Your Question + + + +### What are you trying to achieve? + + +### What have you tried? + + +### Code Example (if applicable) +```typescript +// Paste your code here if it helps explain your question +``` + +### Environment +- TypeScript Version: +- typesafe-actions Version: +- React/Redux Version (if applicable): +- Node Version: diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..40a2e0d --- /dev/null +++ b/examples/README.md @@ -0,0 +1,25 @@ +# Examples Folder + +This folder contains starter templates for bug reports and examples. + +## CodeSandbox Starter + +For bug reports, please use our pre-configured CodeSandbox: +https://codesandbox.io/s/github/piotrwitek/typesafe-actions/tree/master/codesandbox + +## Local Development + +If you want to run examples locally, check the `codesandbox/` folder which contains a complete React + TypeScript + Redux setup with typesafe-actions. + +## Bug Report Template + +When reporting bugs, please: +1. Fork the CodeSandbox above +2. Reproduce your issue in the forked sandbox +3. Share the link in your bug report + +## Available Examples + +- **Todo App**: Complete example in the `codesandbox/` folder +- **Basic Usage**: Check the main README.md for code examples +- **API Examples**: See the test files in `src/` for usage patterns \ No newline at end of file