Add and improve issue templates (Resolves #65)#266
Conversation
- 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 piotrwitek#65
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request improves the project's documentation and issue reporting process by updating the bug report and question templates and adding a README to the examples directory. The changes provide clearer instructions for using CodeSandbox and structure the question template for more detailed submissions. Feedback suggests renaming the question template file for consistency, adding version placeholders to the environment fields, and including a trailing newline in the new README file.
| @@ -1,9 +1,37 @@ | |||
| --- | |||
There was a problem hiding this comment.
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.
| - TypeScript Version: | ||
| - typesafe-actions Version: | ||
| - React/Redux Version (if applicable): | ||
| - Node Version: |
There was a problem hiding this comment.
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.
| - 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 |
|
|
||
| - **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 |
There was a problem hiding this comment.
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.
| - **API Examples**: See the test files in `src/` for usage patterns | |
| - **API Examples**: See the test files in `src/` for usage patterns | |
1 participant
Description
This PR adds and improves issue templates as requested in issue #65.
Changes Made:
Improved bug report template ():
Enhanced question template ():
Added examples folder ():
Requirements Met (from issue #65):
Testing:
All templates are functional and follow GitHub's issue template format. The CodeSandbox link points to the existing codesandbox/ folder in the repository.
Resolves #65