Skip to content

Commit 32c2123

Browse files
N00BSC00BN00BSC00B
committed
Add project structure, templates, and beginner calculator
Introduced initial project structure with directories for basics, intermediate, advanced, projects, and exercises. Added GitHub issue and pull request templates, Hacktoberfest workflow, and contribution guidelines. Included a beginner-friendly calculator project with code and documentation, as well as comprehensive README files for each section.
1 parent 6b5a77b commit 32c2123

File tree

18 files changed

+1224
-1
lines changed

18 files changed

+1224
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: "[BUG] "
5+
labels: "bug"
6+
assignees: ""
7+
---
8+
9+
## 🐛 Bug Description
10+
11+
A clear description of what the bug is.
12+
13+
## 🔄 Steps to Reproduce
14+
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Run '....'
18+
4. See error
19+
20+
## ✅ Expected Behavior
21+
22+
What you expected to happen.
23+
24+
## ❌ Actual Behavior
25+
26+
What actually happened.
27+
28+
## 📱 Environment
29+
30+
- OS: [e.g. Windows 10, macOS, Ubuntu]
31+
- Python Version: [e.g. 3.9.0]
32+
- Browser (if applicable): [e.g. Chrome, Firefox]
33+
34+
## 📎 Additional Context
35+
36+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: "[FEATURE] "
5+
labels: "enhancement"
6+
assignees: ""
7+
---
8+
9+
## 🚀 Feature Description
10+
11+
A clear description of what you want to add.
12+
13+
## 🎯 Problem Statement
14+
15+
What problem does this feature solve?
16+
17+
## 💡 Proposed Solution
18+
19+
Describe the solution you'd like to see.
20+
21+
## 📋 Difficulty Level
22+
23+
- [ ] Beginner
24+
- [ ] Intermediate
25+
- [ ] Advanced
26+
27+
## 🔄 Alternative Solutions
28+
29+
Describe any alternative solutions you've considered.
30+
31+
## 📎 Additional Context
32+
33+
Add any other context, screenshots, or examples about the feature request.

‎.github/ISSUE_TEMPLATE/hacktoberfest.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: Hacktoberfest Contribution
3+
about: Submit your Hacktoberfest 2025 contribution
4+
title: "[HACKTOBERFEST] "
5+
labels: "hacktoberfest"
6+
assignees: ""
7+
---
8+
9+
## 🎃 Hacktoberfest 2025 Contribution
10+
11+
### 📝 What did you add/change?
12+
13+
Describe your contribution.
14+
15+
### 🎯 Difficulty Level
16+
17+
- [ ] Beginner
18+
- [ ] Intermediate
19+
- [ ] Advanced
20+
21+
### 📂 Files Changed
22+
23+
List the main files you modified/added.
24+
25+
### 🧪 Testing
26+
27+
- [ ] Code has been tested
28+
- [ ] Added comments/documentation
29+
- [ ] Follows coding standards
30+
31+
### 📋 Type of Contribution
32+
33+
- [ ] 📝 Documentation
34+
- [ ] 🐛 Bug Fix
35+
- [ ] ✨ New Feature
36+
- [ ] 🎨 Code Example
37+
- [ ] 🧪 Testing
38+
- [ ] 🔧 Refactoring
39+
40+
### 🎉 Additional Notes
41+
42+
Any additional information about your contribution.

‎.github/pull_request_template.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## 📝 Description
2+
3+
Brief description of changes made.
4+
5+
## 🎃 Hacktoberfest 2025
6+
7+
- [ ] This PR is for Hacktoberfest 2025
8+
9+
## 🎯 Type of Change
10+
11+
- [ ] 📝 Documentation update
12+
- [ ] 🐛 Bug fix
13+
- [ ] ✨ New feature
14+
- [ ] 🎨 Code example/tutorial
15+
- [ ] 🧪 Testing
16+
- [ ] 🔧 Code refactoring
17+
18+
## 📋 Difficulty Level
19+
20+
- [ ] Beginner
21+
- [ ] Intermediate
22+
- [ ] Advanced
23+
24+
## ✅ Checklist
25+
26+
- [ ] My code follows the style guidelines
27+
- [ ] I have performed a self-review
28+
- [ ] I have commented my code, particularly in hard-to-understand areas
29+
- [ ] I have made corresponding changes to the documentation
30+
- [ ] My changes generate no new warnings
31+
- [ ] I have added tests that prove my fix is effective or that my feature works
32+
- [ ] New and existing unit tests pass locally with my changes
33+
34+
## 🧪 Testing
35+
36+
Describe how you tested your changes.
37+
38+
## 📸 Screenshots (if applicable)
39+
40+
Add screenshots to help explain your changes.
41+
42+
## 📎 Additional Notes
43+
44+
Any additional information about this PR.

‎.github/workflows/hacktoberfest.yml‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
name: Hacktoberfest Auto-Label
2+
3+
on:
4+
pull_request:
5+
types: [opened]
6+
issues:
7+
types: [opened]
8+
9+
jobs:
10+
label:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Add Hacktoberfest label to PRs
14+
if: github.event_name == 'pull_request'
15+
uses: actions/github-script@v6
16+
with:
17+
script: |
18+
github.rest.issues.addLabels({
19+
issue_number: context.issue.number,
20+
owner: context.repo.owner,
21+
repo: context.repo.repo,
22+
labels: ['hacktoberfest']
23+
})
24+
25+
- name: Welcome new contributors
26+
if: github.event_name == 'pull_request'
27+
uses: actions/github-script@v6
28+
with:
29+
script: |
30+
const welcomeMessage = `
31+
🎃 **Welcome to Hacktoberfest 2025!** 🎃
32+
33+
Thank you for your contribution to Python-Basics-to-Advanced!
34+
35+
Your pull request will be reviewed by our maintainers. Please make sure:
36+
- [ ] Your code follows our style guidelines
37+
- [ ] You've added appropriate comments and documentation
38+
- [ ] You've tested your changes
39+
- [ ] Your PR title is descriptive
40+
41+
Happy coding! 🐍✨
42+
`;
43+
44+
github.rest.issues.createComment({
45+
issue_number: context.issue.number,
46+
owner: context.repo.owner,
47+
repo: context.repo.repo,
48+
body: welcomeMessage
49+
})
50+
51+
test:
52+
runs-on: ubuntu-latest
53+
if: github.event_name == 'pull_request'
54+
steps:
55+
- uses: actions/checkout@v3
56+
57+
- name: Set up Python
58+
uses: actions/setup-python@v4
59+
with:
60+
python-version: "3.x"
61+
62+
- name: Install dependencies
63+
run: |
64+
python -m pip install --upgrade pip
65+
pip install flake8 black
66+
67+
- name: Lint with flake8
68+
run: |
69+
# Stop the build if there are Python syntax errors or undefined names
70+
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
71+
# Exit-zero treats all errors as warnings
72+
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=88 --statistics
73+
74+
- name: Check code formatting with black
75+
run: black --check --diff .

‎CONTRIBUTING.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# 🤝 Contributing to Python-Basics-to-Advanced
2+
3+
Welcome to Hacktoberfest 2025! We welcome contributions from Python developers of all skill levels.
4+
5+
## 🚀 Quick Start
6+
7+
1. **Fork** this repository
8+
2. **Clone** your fork: `git clone https://github.com/N00BSC00B/Python-Basics-to-Advanced.git`
9+
3. **Create** a branch: `git checkout -b your-feature-name`
10+
4. **Make** your changes
11+
5. **Commit**: `git commit -m "Add: your feature"`
12+
6. **Push**: `git push origin your-feature-name`
13+
7. **Create** a Pull Request
14+
15+
## 🎯 What You Can Contribute
16+
17+
### 🔰 Beginners
18+
19+
- Python basics examples (variables, loops, functions)
20+
- Simple projects (calculator, to-do list)
21+
- Documentation improvements
22+
- Fix typos or add comments
23+
24+
### 🎯 Intermediate
25+
26+
- Data structures & algorithms
27+
- Web development tutorials (Flask/Django)
28+
- API examples
29+
- Database connections
30+
31+
### 🚀 Advanced
32+
33+
- Machine learning examples
34+
- Async programming
35+
- Design patterns
36+
- Performance optimization
37+
38+
## 📝 Code Guidelines
39+
40+
```python
41+
"""
42+
Title: Brief description
43+
Author: Your Name
44+
Difficulty: Beginner/Intermediate/Advanced
45+
"""
46+
47+
def example_function(param: str) -> int:
48+
"""Brief description with example."""
49+
# Add helpful comments
50+
return result
51+
```
52+
53+
## ✅ Before Submitting
54+
55+
- [ ] Code works and is tested
56+
- [ ] Added comments for clarity
57+
- [ ] Follows Python style (PEP 8)
58+
- [ ] Updated README if needed
59+
60+
## 🏷️ Labels
61+
62+
- `hacktoberfest` - Valid for Hacktoberfest
63+
- `good-first-issue` - Perfect for beginners
64+
- `beginner/intermediate/advanced` - Difficulty levels
65+
66+
## 🆘 Need Help?
67+
68+
- Open an [issue](https://github.com/N00BSC00B/Python-Basics-to-Advanced/issues)
69+
- Start a [discussion](https://github.com/N00BSC00B/Python-Basics-to-Advanced/discussions)
70+
71+
**Happy Hacking! 🎃**

‎CONTRIBUTORS.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributors
2+
3+
Thank you to all the amazing people who have contributed to this project! 🎉
4+
5+
## Hacktoberfest 2025 Contributors
6+
7+
<!-- This section will be updated automatically as contributions come in -->
8+
9+
## How to Get Listed
10+
11+
1. Make a meaningful contribution to the repository
12+
2. Your pull request gets merged
13+
3. You'll be automatically added to this list!
14+
15+
## Contribution Types
16+
17+
- 📝 **Documentation** - Improved docs, READMEs, comments
18+
- 🐛 **Bug Fix** - Fixed issues and bugs
19+
- ✨ **New Feature** - Added new functionality
20+
- 🎨 **Examples** - Created helpful code examples
21+
- 🧪 **Testing** - Added or improved tests
22+
- 🔧 **Maintenance** - Code cleanup and refactoring
23+
24+
---
25+
26+
_This file is updated manually. If you've contributed and don't see your name, please let us know!_

0 commit comments

Comments
 (0)