Skip to content

Commit 0abe8e9

Browse files
yuis-iceyuis-ice
committed
feat: Internationalize project to English and add comprehensive GitHub publishing setup
### Major Changes - 🌐 **Full English Translation**: Converted all Japanese text to English - Puzzle database with 5 comprehensive logic puzzles - UI components and user interface text - Code comments and documentation - 📋 **GitHub Publishing Setup**: Complete repository preparation - MIT License with proper attribution - Comprehensive README.md with features, setup, and usage - Contributing guidelines with CLA requirements - Issue templates for bugs and feature requests - Pull request template with detailed checklist - GitHub Discussions configuration ### Enhanced Documentation - **README.md**: Full project documentation with installation, usage, and contribution guides - **CONTRIBUTING.md**: Detailed contribution guidelines with CLA agreement - **LICENSE**: MIT license for open source distribution - **.gitignore**: Comprehensive exclusion rules for Node.js, IDE, and build artifacts ### GitHub Templates - **Bug Report Template**: Structured YAML form for issue reporting - **Feature Request Template**: Comprehensive feature proposal format - **Pull Request Template**: Detailed checklist for code contributions - **Issue Configuration**: Contact links and discussion guidelines ### Project Structure - Updated package.json with proper metadata and repository links - Enhanced gitignore with comprehensive exclusion patterns - Screenshot generation for README documentation - Systematic puzzle format maintained for mass production ### Puzzle Database Translation - 5 logic puzzles fully translated to English: - Houses Puzzle: Classic constraint satisfaction - School Clubs: Membership and scheduling logic - Fruit Market: Pricing and inventory constraints - Office Workers: Department and experience rules - Restaurant Menu: Dietary and pricing logic Ready for GitHub publishing with professional documentation and community guidelines.
1 parent 9bf7321 commit 0abe8e9

File tree

13 files changed

+1285
-108
lines changed

13 files changed

+1285
-108
lines changed

‎.github/DISCUSSIONS.md‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
# GitHub Discussions Guidelines
2+
3+
Welcome to the Prolog Logic Puzzle Solver community discussions! This space is for asking questions, sharing ideas, and collaborating on the project.
4+
5+
## 📋 Discussion Categories
6+
7+
### 💡 Ideas
8+
Share your ideas for new features, improvements, or puzzle types. Before posting:
9+
- Search existing discussions to avoid duplicates
10+
- Provide clear use cases and benefits
11+
- Consider implementation complexity
12+
- Include mockups or examples when helpful
13+
14+
### ❓ Q&A
15+
Ask questions about:
16+
- **Usage**: How to use the application or add puzzles
17+
- **Development**: Technical questions about contributing
18+
- **Prolog**: Logic programming and constraint satisfaction
19+
- **Troubleshooting**: Getting help with issues
20+
21+
### 🗣 General
22+
General discussions about:
23+
- Project direction and roadmap
24+
- Educational use cases
25+
- Logic puzzle design principles
26+
- Community feedback
27+
28+
### 📢 Show and Tell
29+
Share your:
30+
- Custom puzzles created with the system
31+
- Educational materials using the solver
32+
- Interesting constraint satisfaction problems
33+
- Extensions or modifications you've built
34+
35+
## 🎯 Discussion Guidelines
36+
37+
### Before Starting a Discussion
38+
39+
1. **Search first**: Check if your topic has been discussed before
40+
2. **Choose the right category**: Select the most appropriate category
41+
3. **Use descriptive titles**: Make it easy for others to find
42+
4. **Add relevant tags**: Help categorize your discussion
43+
44+
### Writing Quality Posts
45+
46+
- **Be specific**: Provide context and details
47+
- **Be respectful**: Maintain a welcoming environment
48+
- **Stay on topic**: Keep discussions focused
49+
- **Use formatting**: Code blocks, lists, and headers improve readability
50+
51+
### Code Sharing
52+
53+
When sharing code:
54+
```typescript
55+
// Use code blocks with syntax highlighting
56+
const newPuzzle: PuzzleProblem = {
57+
id: 'example',
58+
title: 'Example Puzzle',
59+
// ... rest of puzzle definition
60+
}
61+
```
62+
63+
### Puzzle Sharing
64+
65+
When sharing new puzzles:
66+
- Provide **complete puzzle definition**
67+
- Explain the **logical constraints**
68+
- Include **expected solution**
69+
- Test **constraint satisfaction**
70+
71+
## 🔒 Community Standards
72+
73+
### Respectful Communication
74+
- Be kind and constructive
75+
- Welcome newcomers
76+
- Respect different skill levels
77+
- Provide helpful feedback
78+
79+
### Content Guidelines
80+
- Keep discussions relevant to the project
81+
- No spam or promotional content
82+
- No inappropriate or offensive material
83+
- Respect intellectual property
84+
85+
### Helping Others
86+
- Answer questions when you can
87+
- Share your knowledge and experience
88+
- Point to relevant documentation
89+
- Encourage good practices
90+
91+
## 🏆 Recognition
92+
93+
Active community members may be:
94+
- Highlighted in project documentation
95+
- Invited to become maintainers
96+
- Featured in release announcements
97+
- Given special recognition badges
98+
99+
## 📞 Escalation
100+
101+
If you encounter issues:
102+
1. **Flag inappropriate content** using GitHub's reporting tools
103+
2. **Contact maintainers** for serious concerns
104+
3. **Open an issue** for bugs or technical problems
105+
106+
## 🚀 Getting Started
107+
108+
New to the project? Start here:
109+
1. Read the [README.md](../README.md)
110+
2. Check out the [Contributing Guidelines](../CONTRIBUTING.md)
111+
3. Try the [live demo](https://yuis-ice.github.io/prolog-logic-puzzle-solver)
112+
4. Ask questions in the Q&A category
113+
114+
---
115+
116+
Let's build an amazing logic puzzle community together! 🧩✨

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug or issue with the Prolog Logic Puzzle Solver
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thank you for taking the time to report a bug! Please fill out this form to help us understand and fix the issue.
12+
13+
- type: checkboxes
14+
id: terms
15+
attributes:
16+
label: Prerequisites
17+
description: Please confirm you have completed these steps
18+
options:
19+
- label: I have searched for existing issues to avoid duplicates
20+
required: true
21+
- label: I have tried the latest version of the application
22+
required: true
23+
- label: I have read the documentation and troubleshooting guide
24+
required: true
25+
26+
- type: dropdown
27+
id: bug-type
28+
attributes:
29+
label: Bug Type
30+
description: What type of bug are you reporting?
31+
options:
32+
- UI/UX Issue
33+
- Puzzle Solving Logic
34+
- Performance Problem
35+
- Browser Compatibility
36+
- Mobile/Responsive Issue
37+
- Prolog Engine Error
38+
- Data/Content Error
39+
- Accessibility Issue
40+
- Other
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: description
46+
attributes:
47+
label: Bug Description
48+
description: A clear and concise description of what the bug is
49+
placeholder: Describe what happened and what you expected to happen
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: reproduction
55+
attributes:
56+
label: Steps to Reproduce
57+
description: Step-by-step instructions to reproduce the bug
58+
placeholder: |
59+
1. Go to '...'
60+
2. Click on '...'
61+
3. Scroll down to '...'
62+
4. See error
63+
validations:
64+
required: true
65+
66+
- type: textarea
67+
id: expected
68+
attributes:
69+
label: Expected Behavior
70+
description: What did you expect to happen?
71+
placeholder: Describe the expected behavior
72+
validations:
73+
required: true
74+
75+
- type: textarea
76+
id: actual
77+
attributes:
78+
label: Actual Behavior
79+
description: What actually happened?
80+
placeholder: Describe what actually happened instead
81+
validations:
82+
required: true
83+
84+
- type: dropdown
85+
id: browser
86+
attributes:
87+
label: Browser
88+
description: Which browser are you using?
89+
options:
90+
- Chrome
91+
- Firefox
92+
- Safari
93+
- Edge
94+
- Mobile Safari (iOS)
95+
- Chrome Mobile (Android)
96+
- Other
97+
validations:
98+
required: true
99+
100+
- type: input
101+
id: browser-version
102+
attributes:
103+
label: Browser Version
104+
description: What version of the browser are you using?
105+
placeholder: e.g., 119.0.6045.105
106+
validations:
107+
required: true
108+
109+
- type: dropdown
110+
id: os
111+
attributes:
112+
label: Operating System
113+
description: What operating system are you using?
114+
options:
115+
- Windows 11
116+
- Windows 10
117+
- macOS Sonoma (14.x)
118+
- macOS Ventura (13.x)
119+
- macOS Monterey (12.x)
120+
- Ubuntu/Debian
121+
- Other Linux
122+
- iOS
123+
- Android
124+
- Other
125+
validations:
126+
required: true
127+
128+
- type: dropdown
129+
id: device
130+
attributes:
131+
label: Device Type
132+
description: What type of device are you using?
133+
options:
134+
- Desktop/Laptop
135+
- Mobile Phone
136+
- Tablet
137+
- Other
138+
validations:
139+
required: true
140+
141+
- type: textarea
142+
id: console-logs
143+
attributes:
144+
label: Console Logs
145+
description: Any relevant error messages from the browser console (F12 → Console)
146+
placeholder: Paste any error messages or console output here
147+
render: text
148+
149+
- type: textarea
150+
id: additional-context
151+
attributes:
152+
label: Additional Context
153+
description: Add any other context about the problem here
154+
placeholder: |
155+
- Does this happen consistently or intermittently?
156+
- Are there any workarounds?
157+
- Any specific puzzle or feature affected?
158+
- Screenshots or screen recordings (if applicable)
159+
160+
- type: dropdown
161+
id: severity
162+
attributes:
163+
label: Bug Severity
164+
description: How severe is this bug?
165+
options:
166+
- Critical (Application unusable)
167+
- High (Major functionality affected)
168+
- Medium (Minor functionality affected)
169+
- Low (Cosmetic or minor issue)
170+
validations:
171+
required: true
172+
173+
- type: checkboxes
174+
id: willingness
175+
attributes:
176+
label: Contribution
177+
description: Are you willing to help fix this bug?
178+
options:
179+
- label: I am willing to submit a pull request to fix this bug
180+
- label: I can help test the fix once it's implemented
181+
- label: I can provide additional information if needed

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 GitHub Discussions
4+
url: https://github.com/yuis-ice/prolog-logic-puzzle-solver/discussions
5+
about: Ask questions, share ideas, and discuss the project with the community
6+
7+
- name: 📖 Documentation
8+
url: https://github.com/yuis-ice/prolog-logic-puzzle-solver#readme
9+
about: Check the README and documentation for usage instructions and FAQ
10+
11+
- name: 🚀 Live Demo
12+
url: https://yuis-ice.github.io/prolog-logic-puzzle-solver
13+
about: Try the application live to understand features and functionality
14+
15+
- name: 🤝 Contributing Guide
16+
url: https://github.com/yuis-ice/prolog-logic-puzzle-solver/blob/main/CONTRIBUTING.md
17+
about: Learn how to contribute to the project and development guidelines
18+
19+
- name: ✉️ Contact Maintainer
20+
url: mailto:jobs.fumiya@pm.me
21+
about: Contact the project maintainer for sensitive issues or collaboration inquiries

0 commit comments

Comments
 (0)