Skip to content

Commit 8f485dd

Browse files
committed
Update contrib docs for aspiring devs
1 parent d77c630 commit 8f485dd

1 file changed

Lines changed: 25 additions & 9 deletions

File tree

β€ŽCONTRIBUTING.mdβ€Ž

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,22 @@ Our README is like the opening act at a concert. It's where the party starts, an
2323

2424
Our Python modules are like mini-python-parties that you can host anywhere! They're packed with energy and make learning a blast! πŸŽ‰
2525

26+
### πŸ“‚ Category Folders
27+
28+
We organize our Python modules into clean, logical categories:
29+
- `ultimatepython/fundamentals/` - Core syntax and basic constructs.
30+
- `ultimatepython/oop/` - Object-Oriented Programming principles.
31+
- `ultimatepython/stdlib/` - Python standard library modules.
32+
- `ultimatepython/advanced/` - Metaprogramming and advanced features.
33+
- `ultimatepython/concurrency/` - Multitasking models.
34+
- `ultimatepython/engineering/` - Profiling, algorithms, and data structures.
35+
36+
If you are adding a new lesson, please place it in the appropriate folder.
37+
38+
### 🏷️ Python Version Badges
39+
40+
If your new lesson showcases a cutting-edge feature (like a new syntax feature in Python 3.8+), please update the `LESSON_ANNOTATIONS` dictionary in [ui/parse_lessons.py](file:///Users/samhuang/Playground/projects/ultimate-python/ui/parse_lessons.py). This will automatically display the version badge (e.g., `Python 3.10`) on the web UI!
41+
2642
### 🧩 The Setup
2743

2844
Each Python module follows a rock-solid structure:
@@ -65,39 +81,39 @@ Your contributions are like the encore at a concert - they're a big deal! We app
6581

6682
So, get ready to rock and roll, Python style! 🀘🐍πŸ’₯
6783

68-
# πŸ’₯ Dive into the Python World
84+
## πŸ’₯ Dive into the Python World
6985

7086
Python is a versatile language used in web development, data analysis, artificial intelligence, and more. As a contributor, you're joining a vibrant community of learners and mentors.
7187

72-
# πŸ§‘β€πŸ’» Learning Together
88+
## πŸ§‘β€πŸ’» Learning Together
7389

7490
Our project isn't just a repository; it's a collaborative learning experience. You can learn from the contributions of others and share your Python wisdom with the world. Together, we can unlock the true potential of this fantastic language.
7591

76-
# πŸš€ Opportunities Galore
92+
## πŸš€ Opportunities Galore
7793

7894
When you contribute to this project, you're not just improving it; you're also enhancing your own skills. You might discover new Python tricks, learn more about best practices, and even find inspiration for your own projects.
7995

80-
# 🌍 Global Impact
96+
## 🌍 Global Impact
8197

8298
Python is a worldwide phenomenon, and your contributions will impact Python enthusiasts globally. Your work can help someone on the other side of the planet learn Python, kickstart their career, or solve a problem they've been struggling with.
8399

84-
# πŸ™‹β€β™€οΈ Join a Supportive Community
100+
## πŸ™‹β€β™€οΈ Join a Supportive Community
85101

86102
Our community is welcoming and supportive. If you have questions or need guidance, don't hesitate to ask. We're all here to help each other and grow together.
87103

88-
# πŸ“’ Your Voice Matters
104+
## πŸ“’ Your Voice Matters
89105

90106
Your unique perspective is valuable. If you have ideas to make this guide even more engaging or fun, share them with us! We're open to creative and innovative suggestions.
91107

92-
# πŸ€– Evolving with Python
108+
## πŸ€– Evolving with Python
93109

94110
Python is constantly evolving, and so is our guide. You can help keep it up-to-date, ensuring that learners always have access to the latest Python features and best practices.
95111

96-
# πŸŽ‰ Your Contribution Matters
112+
## πŸŽ‰ Your Contribution Matters
97113

98114
Your contributions, whether they are big or small, are the building blocks of our project's success. Together, we're creating a resource that makes Python more accessible and exciting.
99115

100-
# 🌟 Be a Python Star
116+
## 🌟 Be a Python Star
101117

102118
By contributing to this project, you're becoming a Python star, and you're helping others shine brightly too. Let's light up the Python world together!
103119

0 commit comments

Comments
Β (0)