Skip to content

Commit 3f4536d

Browse files
ZemerikZemerik
committed
feat: Initial repository setup with documentation and GitHub workflows
0 parents  commit 3f4536d

16 files changed

Lines changed: 1324 additions & 0 deletions

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
name: 🐛 Bug Report
3+
about: Create a report to help us improve the learning materials
4+
title: '[BUG] '
5+
labels: ['bug', 'needs-triage']
6+
assignees: ''
7+
---
8+
9+
## 🐛 Bug Description
10+
11+
<!-- A clear and concise description of what the bug is -->
12+
13+
## 🔍 Steps to Reproduce
14+
15+
1. Go to '...' (which day/folder)
16+
2. Open '...' (which file)
17+
3. Run '...' (what command)
18+
4. See error
19+
20+
## ✅ Expected Behavior
21+
22+
<!-- A clear and concise description of what you expected to happen -->
23+
24+
## ❌ Actual Behavior
25+
26+
<!-- A clear and concise description of what actually happened -->
27+
28+
## 📸 Screenshots
29+
30+
<!-- If applicable, add screenshots to help explain your problem -->
31+
32+
## 💻 Environment
33+
34+
**Java Version:**
35+
- [ ] Java 8
36+
- [ ] Java 11
37+
- [ ] Java 17
38+
- [ ] Java 21
39+
- [ ] Other: _____
40+
41+
**Operating System:**
42+
- [ ] Windows
43+
- [ ] macOS
44+
- [ ] Linux
45+
- [ ] Other: _____
46+
47+
**IDE/Editor:**
48+
- [ ] IntelliJ IDEA
49+
- [ ] Eclipse
50+
- [ ] VS Code
51+
- [ ] NetBeans
52+
- [ ] Other: _____
53+
54+
## 📋 Additional Context
55+
56+
<!-- Add any other context about the problem here -->
57+
58+
## 🔧 Possible Solution
59+
60+
<!-- If you have suggestions on a fix for the bug, please describe it here -->
61+
62+
## 📝 Error Messages
63+
64+
<!-- If there are any error messages, please include them here -->
65+
66+
```
67+
Paste error messages here
68+
```
69+
70+
---
71+
72+
**Thank you for helping us improve! 🚀**

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 📖 Java
4+
url: https://github.com/Zemerik/Java/discussions
5+
about: Join our community discussions and ask questions!

‎.github/ISSUE_TEMPLATE/content_improvement.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
name: 📚 Content Improvement
3+
about: Suggest improvements to existing learning materials
4+
title: '[CONTENT] '
5+
labels: ['content', 'improvement', 'needs-triage']
6+
assignees: ''
7+
---
8+
9+
## 📚 Content to Improve
10+
11+
<!-- Specify which content you'd like to improve -->
12+
13+
**Day/Folder:** _____
14+
**File(s):** _____
15+
16+
## 🔍 Current Content
17+
18+
<!-- Describe the current content and what could be improved -->
19+
20+
## 💡 Suggested Improvements
21+
22+
<!-- Describe the specific improvements you'd like to see -->
23+
24+
- [ ] Better explanations
25+
- [ ] More examples
26+
- [ ] Additional exercises
27+
- [ ] Code comments
28+
- [ ] Visual aids
29+
- [ ] Real-world applications
30+
- [ ] Best practices
31+
- [ ] Common pitfalls
32+
- [ ] Performance tips
33+
- [ ] Other: _____
34+
35+
## 🎯 Specific Changes
36+
37+
<!-- List the specific changes you'd like to make -->
38+
39+
1. **Change 1:**
40+
- Current: _____
41+
- Proposed: _____
42+
43+
2. **Change 2:**
44+
- Current: _____
45+
- Proposed: _____
46+
47+
3. **Change 3:**
48+
- Current: _____
49+
- Proposed: _____
50+
51+
## 📋 Content Type
52+
53+
<!-- What type of content improvement is this? -->
54+
55+
- [ ] README.md improvements
56+
- [ ] Java code examples
57+
- [ ] Exercise additions
58+
- [ ] Documentation updates
59+
- [ ] Code comments
60+
- [ ] Error handling
61+
- [ ] Performance optimization
62+
- [ ] Other: _____
63+
64+
## 🎯 Learning Impact
65+
66+
<!-- How will this improvement help learners? -->
67+
68+
## 📸 Examples
69+
70+
<!-- If you have specific examples of the improvements, please share them -->
71+
72+
## 🔗 Related Issues
73+
74+
<!-- Are there any related issues or discussions? -->
75+
76+
## 📝 Additional Context
77+
78+
<!-- Any other information that might be helpful -->
79+
80+
---
81+
82+
**Thank you for helping us improve! 🚀**

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
name: ✨ Feature Request
3+
about: Suggest an idea for improving the learning materials
4+
title: '[FEATURE] '
5+
labels: ['enhancement', 'needs-triage']
6+
assignees: ''
7+
---
8+
9+
## 🎯 Feature Description
10+
11+
<!-- A clear and concise description of the feature you'd like to see -->
12+
13+
## 💡 Problem Statement
14+
15+
<!-- Is your feature request related to a problem? Please describe -->
16+
17+
## 🚀 Proposed Solution
18+
19+
<!-- A clear and concise description of what you want to happen -->
20+
21+
## 🔄 Alternative Solutions
22+
23+
<!-- A clear and concise description of any alternative solutions or features you've considered -->
24+
25+
## 📚 Content Type
26+
27+
<!-- What type of content would this feature add? -->
28+
29+
- [ ] New day/topic
30+
- [ ] Additional examples
31+
- [ ] More exercises
32+
- [ ] Better explanations
33+
- [ ] Interactive content
34+
- [ ] Video tutorials
35+
- [ ] Cheat sheets
36+
- [ ] Real-world projects
37+
- [ ] Other: _____
38+
39+
## 🎯 Target Audience
40+
41+
<!-- Who would benefit from this feature? -->
42+
43+
- [ ] Complete beginners
44+
- [ ] Intermediate learners
45+
- [ ] Advanced developers
46+
- [ ] All skill levels
47+
48+
## 📋 Implementation Ideas
49+
50+
<!-- If you have ideas on how to implement this feature, please share them -->
51+
52+
## 📸 Mockups/Examples
53+
54+
<!-- If applicable, add mockups or examples of what this feature might look like -->
55+
56+
## 🔗 Related Content
57+
58+
<!-- Is this feature related to existing content? If so, please specify -->
59+
60+
- Related to Day: _____
61+
- Related file: _____
62+
63+
## 📝 Additional Context
64+
65+
<!-- Add any other context or screenshots about the feature request here -->
66+
67+
---
68+
69+
**Thank you for helping us improve! 🚀**

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
name: ❓ Question
3+
about: Ask a question about the learning materials or Java programming
4+
title: '[QUESTION] '
5+
labels: ['question', 'help-wanted']
6+
assignees: ''
7+
---
8+
9+
## ❓ Question
10+
11+
<!-- What is your question? Please be as specific as possible -->
12+
13+
## 📚 Related Content
14+
15+
<!-- Which day or topic is your question related to? -->
16+
17+
**Day/Folder:** _____
18+
**File(s):** _____
19+
20+
## 🔍 What I've Tried
21+
22+
<!-- Describe what you've already tried to understand or solve this -->
23+
24+
## 💻 Code Example (if applicable)
25+
26+
<!-- If your question involves code, please share a minimal example -->
27+
28+
```java
29+
// Your code here
30+
```
31+
32+
## 🎯 What I'm Trying to Achieve
33+
34+
<!-- What are you trying to accomplish? -->
35+
36+
## 📋 My Current Understanding
37+
38+
<!-- What do you currently understand about this topic? -->
39+
40+
## 🔗 Additional Resources
41+
42+
<!-- Have you checked any additional resources? -->
43+
44+
- [ ] Java Documentation
45+
- [ ] Stack Overflow
46+
- [ ] Other tutorials
47+
- [ ] Books
48+
- [ ] Videos
49+
- [ ] Other: _____
50+
51+
## 📝 Additional Context
52+
53+
<!-- Any other information that might help answer your question -->
54+
55+
## 🏷️ Question Type
56+
57+
<!-- What type of question is this? -->
58+
59+
- [ ] Concept clarification
60+
- [ ] Code debugging
61+
- [ ] Best practices
62+
- [ ] Implementation help
63+
- [ ] Learning path guidance
64+
- [ ] Setup/installation
65+
- [ ] Other: _____
66+
67+
---
68+
69+
**We're here to help you learn Java! 🚀**

‎.github/pull_request_template.md‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
## 📝 Pull Request Description
2+
3+
<!-- Provide a brief description of what this PR accomplishes -->
4+
5+
## 🎯 Type of Change
6+
7+
Please delete options that are not relevant:
8+
9+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
10+
- [ ] ✨ New feature (non-breaking change which adds functionality)
11+
- [ ] 📚 Content improvement (enhancing existing material)
12+
- [ ] 📖 Documentation update
13+
- [ ] 🔧 Code refactoring
14+
- [ ] 🧪 Test addition or improvement
15+
- [ ] 🎨 UI/UX improvement
16+
17+
## 📋 What was changed?
18+
19+
<!-- List the specific changes made in this PR -->
20+
21+
- [ ]
22+
- [ ]
23+
- [ ]
24+
25+
## 🧪 Testing
26+
27+
<!-- Please describe the tests that you ran to verify your changes -->
28+
29+
- [ ] ✅ Code compiles without errors
30+
- [ ] ✅ Examples run successfully
31+
- [ ] ✅ Documentation is clear and accurate
32+
- [ ] ✅ No breaking changes introduced
33+
- [ ] ✅ Follows project coding standards
34+
35+
## 📸 Screenshots (if applicable)
36+
37+
<!-- Add screenshots if your changes affect the UI or output -->
38+
39+
## 🔗 Related Issues
40+
41+
<!-- Link any related issues here -->
42+
43+
Closes #(issue number)
44+
Related to #(issue number)
45+
46+
## 📝 Additional Notes
47+
48+
<!-- Any additional information or context for reviewers -->
49+
50+
## ✅ Checklist
51+
52+
Before submitting this PR, please make sure:
53+
54+
- [ ] I have read the [CONTRIBUTING.md](CONTRIBUTING.md) file
55+
- [ ] My code follows the project's coding standards
56+
- [ ] I have tested my changes thoroughly
57+
- [ ] I have updated documentation where necessary
58+
- [ ] My changes generate no new warnings
59+
- [ ] I have added comments to complex code sections
60+
- [ ] I have created appropriate tests if applicable
61+
62+
## 🎉 Ready for Review
63+
64+
This PR is ready for review and ready to be merged once approved.
65+
66+
---
67+
68+
**Thank you for contributing! 🚀**

0 commit comments

Comments
 (0)