Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,16 @@ https://github.com/piotrwitek/typesafe-actions#extending-internal-types-to-enabl

<!-- You have two options, fill in a codesandbox template or provide full working code example. -->

### CodeSandbox Link
### CodeSandbox Link (Recommended)
<!--
Codesandbox will speed response time and your issue will be prioritized because it's easier to analyze:
Codesandbox will speed response time and your issue will be prioritized because it's easier to analyze.

**Click this link to open a pre-configured CodeSandbox with typesafe-actions:**
https://codesandbox.io/s/github/piotrwitek/typesafe-actions/tree/master/codesandbox

Then fork it, reproduce your bug, and paste the link here.
-->
*(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.
Expand Down
36 changes: 32 additions & 4 deletions .github/ISSUE_TEMPLATE/custom.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,37 @@
---

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The pull request description mentions that this template was renamed from 'custom' to 'question', but the file path remains .github/ISSUE_TEMPLATE/custom.md. Renaming the file to question.md would ensure consistency with the template's name and the PR's stated changes.

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

<!-- Please provide as much detail as possible about your question -->

### What are you trying to achieve?
<!-- Describe what you're trying to do with typesafe-actions -->

### What have you tried?
<!-- Share what approaches you've already attempted -->

### 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:
Comment on lines +34 to +37

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Adding placeholders (e.g., X.X.X) to the environment fields would make the template consistent with the bug report template and provide clearer guidance to users on what information is expected.

Suggested change
- TypeScript Version:
- typesafe-actions Version:
- React/Redux Version (if applicable):
- Node Version:
- TypeScript Version: X.X.X
- typesafe-actions Version: X.X.X
- React/Redux Version (if applicable): X.X.X
- Node Version: X.X.X

25 changes: 25 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The file is missing a trailing newline. It is a standard practice to include a newline at the end of text files to ensure compatibility with various tools and to avoid warnings in diffs.

Suggested change
- **API Examples**: See the test files in `src/` for usage patterns
- **API Examples**: See the test files in `src/` for usage patterns