Skip to content
Merged
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
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
name: Bug Report
about: Create a report to help us improve TextTangle
title: '[BUG] '
labels: ['bug']
assignees: ''

---

## ๐Ÿ› Bug Description
A clear and concise description of what the bug is.

## ๐Ÿ”„ Steps to Reproduce
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Select '....'
4. See error

## โœ… Expected Behavior
A clear and concise description of what you expected to happen.

## โŒ Actual Behavior
A clear and concise description of what actually happened.

## ๐Ÿ“ธ Screenshots
If applicable, add screenshots to help explain your problem.

## ๐Ÿ–ฅ๏ธ Environment Information
**Device Information:**
- Device: [e.g. Desktop, Mobile]
- OS: [e.g. Windows 11, macOS, iOS]
- Browser: [e.g. Chrome, Firefox, Safari]
- Browser Version: [e.g. 118.0]

**Game Information:**
- Game Mode: [e.g. Daily Challenge, Custom Word]
- Difficulty: [e.g. Easy, Medium, Hard]
- Word Length: [e.g. 4, 5, 6, 7 letters]
- Settings: [e.g. Sound ON/OFF, Colorblind Mode ON/OFF]

## ๐Ÿ“ Additional Context
Add any other context about the problem here. Include any error messages, console logs, or other relevant information.

## โšก Priority
- [ ] Low - Minor issue, doesn't affect core functionality
- [ ] Medium - Affects some functionality but has workarounds
- [ ] High - Affects core functionality
- [ ] Critical - Game breaking issue
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: ๐ŸŽฎ Live Demo
url: https://eccentriccoder01.github.io/TextTangle
about: Try TextTangle live to see if you can reproduce the issue
- name: ๐Ÿ“š Documentation
url: https://github.com/eccentriccoder01/TextTangle/blob/main/README.md
about: Check the README for game features and instructions
57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
name: Feature Request
about: Suggest an idea for TextTangle
title: '[FEATURE] '
labels: ['enhancement']
assignees: ''

---

## ๐Ÿš€ Feature Description
A clear and concise description of the feature you'd like to see added.

## ๐Ÿ’ก Motivation
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

## ๐Ÿ“‹ Detailed Description
**Describe the solution you'd like**
A clear and concise description of what you want to happen.

## ๐ŸŽฏ Use Cases
Describe specific scenarios where this feature would be useful:
- Use case 1: ...
- Use case 2: ...
- Use case 3: ...

## ๐Ÿ–ผ๏ธ Mockups/Examples (Optional)
If applicable, add sketches, mockups, or examples to help visualize the feature.

## ๐Ÿ”„ Alternatives Considered
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

## ๐ŸŽฎ Impact on Gameplay
How would this feature affect the current gameplay experience?
- [ ] Enhances existing features
- [ ] Adds new gameplay mechanics
- [ ] Improves accessibility
- [ ] Improves user interface
- [ ] Improves performance
- [ ] Other: ___________

## ๐Ÿ“ฑ Platform Considerations
Which platforms should this feature support?
- [ ] Desktop Web
- [ ] Mobile Web
- [ ] All platforms

## โš–๏ธ Priority
How important is this feature to you?
- [ ] Nice to have
- [ ] Would improve experience significantly
- [ ] Essential for better gameplay
- [ ] Critical accessibility need

## ๐Ÿ“ Additional Context
Add any other context, screenshots, or examples about the feature request here.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Question
about: Ask a question about TextTangle
title: '[QUESTION] '
labels: ['question']
assignees: ''

---

## โ“ Question
What would you like to know about TextTangle?

## ๐ŸŽฏ Context
Provide some context for your question. What are you trying to achieve?

## ๐Ÿ” What I've Tried
Have you tried looking for an answer elsewhere? Please describe what you've already tried:
- [ ] Checked the README
- [ ] Searched existing issues
- [ ] Tried the live demo
- [ ] Other: ___________

## ๐Ÿ“ฑ Environment (if relevant)
If your question is related to a specific setup:
- Device: [e.g. Desktop, Mobile]
- OS: [e.g. Windows, macOS, iOS]
- Browser: [e.g. Chrome, Firefox, Safari]

## ๐Ÿ“ Additional Information
Any additional information that might help answer your question.
76 changes: 76 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
## ๐Ÿ”„ Pull Request Description

### ๐Ÿ“‹ Summary
<!-- Provide a brief description of the changes in this PR -->

### ๐ŸŽฏ Type of Change
<!-- Mark the relevant option with an [x] -->
- [ ] ๐Ÿ› Bug fix (non-breaking change which fixes an issue)
- [ ] โœจ New feature (non-breaking change which adds functionality)
- [ ] ๐Ÿ’ฅ Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] ๐Ÿ“š Documentation update
- [ ] ๐Ÿ”ง Code refactoring (no functional changes)
- [ ] ๐ŸŽจ UI/UX improvements
- [ ] โšก Performance improvements
- [ ] ๐Ÿงช Test additions or updates

### ๐Ÿ”— Related Issues
<!-- Link to related issues using: Fixes #123, Closes #456, etc. -->
Fixes #

### ๐Ÿงช Testing
<!-- Describe how you tested your changes -->
- [ ] I have tested these changes locally
- [ ] I have tested on different browsers
- [ ] I have tested on mobile devices
- [ ] I have tested all difficulty levels
- [ ] I have tested both Daily and Custom modes

**Test Steps:**
1.
2.
3.

### ๐Ÿ“ธ Screenshots/Videos (if applicable)
<!-- Add screenshots or videos to demonstrate the changes -->

**Before:**
<!-- Screenshot/description of behavior before changes -->

**After:**
<!-- Screenshot/description of behavior after changes -->

### ๐ŸŽฎ Gameplay Impact
<!-- Describe how this affects the game experience -->
- [ ] No impact on gameplay
- [ ] Improves existing functionality
- [ ] Adds new gameplay features
- [ ] Changes game mechanics
- [ ] Fixes gameplay bugs

### ๐Ÿ–ฅ๏ธ Browser Compatibility
<!-- Mark the browsers you've tested -->
- [ ] Chrome
- [ ] Firefox
- [ ] Safari
- [ ] Edge
- [ ] Mobile browsers

### โœ… Checklist
<!-- Mark completed items with [x] -->
- [ ] My code follows the project's style guidelines
- [ ] I have performed a self-review of my code
- [ ] I have commented my code in hard-to-understand areas
- [ ] My changes generate no new console warnings or errors
- [ ] I have tested that existing functionality still works
- [ ] Any new features are properly documented
- [ ] The UI remains responsive on different screen sizes

### ๐Ÿ“ Additional Notes
<!-- Any additional information reviewers should know -->

### ๐Ÿš€ Deployment Notes
<!-- Any special considerations for deployment -->
- [ ] No special deployment steps needed
- [ ] Requires cache clearing
- [ ] Other: ___________