-
-
Notifications
You must be signed in to change notification settings - Fork 106
Add and improve issue templates (Resolves #65) #266
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -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 | ||||||||||||||||||
|
|
||||||||||||||||||
| <!-- 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
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adding placeholders (e.g.,
Suggested change
|
||||||||||||||||||
| 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 | ||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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
|
||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 toquestion.mdwould ensure consistency with the template's name and the PR's stated changes.