Updated CONTRIBUTING.md, made it better (huangsam#110)

0Armaan025 · web-flow · commit 1906ca527862 · 2023-10-19T10:19:39.000-07:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,95 +1,124 @@
-# Contributing
+# 🚀 Welcome to the Ultimate Python Study Guide! 📚
 
-Thanks for taking the time to understand how you can contribute to the
-Ultimate Python Study guide!
+🎉 Thank you for considering contributing to this awesome project! 🎉
 
-Please take a look at the [code of conduct](CODE_OF_CONDUCT.md) before
-proceeding further.
+But first, before you jump in, let's vibe with our [Code of Conduct](CODE_OF_CONDUCT.md). We want this space to be 🌈 inclusive, respectful, and nothing but fun!
 
----
+## 🐍 What's This All About?
 
-The repository consists of documentation and Python modules. Before you
-contribute to the repository with a pull request, review all of the standards
-listed in upcoming sections. That way, you can maintain the craftsmanship of
-this project and still make an impact on the developers using this project
-for learning purposes.
+Our Python Study Guide is your ticket to Python mastery! 🐍 This place is all about energy, excitement, and pure Python magic. 💫
 
-## README documentation
+## 📖 Let's Talk Documentation
 
-The [README](README.md) is important because it is the most frequently viewed
-page in this repository. As such, any changes that are made to this page must
-follow these guidelines:
+Our README is like the opening act at a concert. It's where the party starts, and we want it to be sensational! Here are the keys to this performance:
 
-- Translations are referenced at the top
-- Python modules are referenced in the ToC
-- External links point to HTTPS resources that return a `2xx` status
-- Python documentation is useful for newcomers and professionals
-- GitHub repositories have at least 1k stars
-- Practice resources have Python exercises
+- Translations? 🌍 Yes, they're right at the top for everyone to enjoy!
+- Python modules? 🤓 Oh, they've got a VIP seat in our Table of Contents (ToC).
+- External links? 🔗 They're all about HTTPS and that sweet `2xx` status.
+- Python documentation? For both newbies and wizards, it's all in here!
+- GitHub repositories? 🌟 We love stars! If it's got at least 1k stars, bring it on!
+- Practice resources? 🏋️‍♂️ We've got Python exercises to keep you in shape.
 
-## Python modules
+## 📚 Get into Python Modules
 
-Every Python module is a standalone lesson which helps developers build
-their own intuition for core Python. Each module has a name that corresponds
-to a topic and explores concepts with `assert` statements. This approach
-encourages test-driven development and makes it simple for developers to
-discern what the expected output from the code is.
+Our Python modules are like mini-python-parties that you can host anywhere! They're packed with energy and make learning a blast! 🎉
 
-Certain Python concepts are skipped in this study guide because the modules
-do not reference each other and make small use of I/O operations. But this
-limitation also allows the lessons to be pasted freely to any computing
-environment such as an IDE, a browser window or a standalone application.
+### 🧩 The Setup
 
-When creating or updating Python modules, please respect the guidelines in
-the sub-sections below.
-
-### Standard structure
-
-Every standalone Python module consists of the following:
+Each Python module follows a rock-solid structure:
 
 ```python
-# Main function
+# The main event 🎉
 def main():
-    # Assertion comments
+    # Here's where the magic happens!
     assert 1 + 1 == 2
     assert True is not False
 
-
-# Main function conditional
+# The show must go on
 if __name__ == "__main__":
     main()
 ```
 
-If the module involves additional functions and classes, they are placed
-above the `main` function.
+If there's more Python goodness, it's up front before the main event!
 
-### Style conventions
+### ✨ Style and Shine
 
-The project follows conventions from these PEP proposals:
+We've got style, oh baby! Check out the PEPs:
 
-- [PEP 8 -- Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/)
-- [PEP 257 -- Docstring Conventions](https://www.python.org/dev/peps/pep-0257/)
+- [PEP 8](https://www.python.org/dev/peps/pep-0008) - Our fashion bible!
+- [PEP 257](https://www.python.org/dev/peps/pep-0257) - Docstring Glamour!
 
-The project has additional conventions:
+But there's more! We have our own style:
 
-- Module imports are arranged by [isort](https://github.com/timothycrosley/isort)
-- Module constants follow an `_UNDER_SCORE_FIRST` convention
-- Strings have "double-quotes" unless a `"` exists in the string
-- Dynamic strings make use of [f-strings](https://www.python.org/dev/peps/pep-0498/)
+- Imports are perfectly sorted with [isort](https://github.com/timothycrosley/isort).
+- Constants? They follow the `_UNDER_SCORE_FIRST` party rule.
+- Strings love double-quotes, but if there's a `"`, they'll use single quotes!
+- For dynamic strings, it's all about those fabulous f-strings! 🎤
 
-### Code coverage
+### 📈 Code Coverage Stars
 
-Each module should have 80-100% code coverage with the [test runner](runner.py).
-The reason for this high standard is that the repository code is relatively
-simple. All interactive learning tends to revolve around the `main` function
-since that is where the assertions are. That way, developers immediately know
-when they make a mistake in the module. This is valuable feedback because it
-helps them improve quickly.
+We like to keep the energy high, and that means every module should have a whopping 80-100% code coverage! Our modules are like dance floors, and we don't want any empty spaces. That's because each module is a standalone lesson, and the `main` function is where the magic happens.
 
-To validate code coverage, run the following commands:
+## 🌟 Your Contribution
 
-```bash
-$ coverage run -m runner
-$ coverage html
-$ open htmlcov/index.html
-```
+Your contributions are like the encore at a concert - they're a big deal! We appreciate your dedication to making this project even more amazing. Don't hesitate to reach out if you have any questions. Your contributions, no matter how small, are making a big difference in the Python learning world!
+
+So, get ready to rock and roll, Python style! 🤘🐍💥
+
+# 💥 Dive into the Python World
+
+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.
+
+# 🧑‍💻 Learning Together
+
+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.
+
+# 🚀 Opportunities Galore
+
+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.
+
+# 🌍 Global Impact
+
+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.
+
+# 🙋‍♀️ Join a Supportive Community
+
+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.
+
+# 📢 Your Voice Matters
+
+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.
+
+# 🤖 Evolving with Python
+
+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.
+
+# 🎉 Your Contribution Matters
+
+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.
+
+# 🌟 Be a Python Star
+
+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!
+
+## How to Contribute
+
+Ready to dive in? Here's how you can contribute:
+
+1. **Fork the Repository**: Head to [https://github.com/huangsam/ultimate-python/](https://github.com/huangsam/ultimate-python/) and click the "Fork" button in the top right corner.
+
+2. **Clone Your Fork**: After forking, you'll have your copy of the repository. Clone it to your local machine.
+
+
+
+3. **Make Your Contributions**: Create or update Python modules, documentation, or anything that adds value to the project.
+
+4. **Push Your Changes**: Once your work is ready, push your changes to your forked repository.
+
+5. **Create a Pull Request**: Head back to the original repository (https://github.com/huangsam/ultimate-python/) and create a pull request. Describe your changes and let us know why they're awesome.
+
+We're excited to see what you bring to the table! Your contributions are making the Python world a better place.
+
+Please don't hesitate to reach out if you have any questions. Your contributions, no matter how small, are making a big difference! 🌟🐍💥
+
+## Feel the Pythonic Energy - Contribute Now!🔥
