Skip to content

Contributing to py-simple-wrap 🚀

First of all, thank you for being here! I created py-simple-wrap to help others on their learning journey, and I'm excited to have you join me.

I struggle with anxiety myself, so I totally understand if you're feeling nervous about contributing. Please don't be! The absolute worst thing that could happen is that I might ask for a few changes before merging your code. This is a safe space to learn, make mistakes, and grow together.

⭐ Enjoying the project?

If py-simple-wrap has been useful, or you just like what it's doing, a star means a lot — it helps other beginners discover the project and keeps me motivated to keep building it. It takes two seconds and costs nothing. 🙏

The "Simple" Philosophy

Before submitting a new feature, ask yourself: "Does this make a complex task easier for a beginner?" My goal is to keep things intuitive and easy to read.

🛠️ Step-by-Step Guide for Beginners

If you've never contributed to an open-source project before, here is exactly how to do it:

  1. Fork the Project: Click the "Fork" button at the top right of this GitHub page. This creates your own copy of the project.
  2. Get the Clone Link:
  3. On your fork's GitHub page, click the green <> Code button.
  4. Make sure the HTTPS tab is selected.
  5. Click the little "copy" icon (two overlapping squares) next to the URL to copy it to your clipboard.
  6. Clone Your Fork: Open your terminal, type git clone, and then paste the link you just copied:
git clone https://github.com/YOUR_USERNAME/py-simple-wrap.git
  1. Create a Branch: It's best to do your work on a new branch:
git checkout -b my-new-feature
  1. Write Your Code: Add your awesome new function or fix that bug!
  2. Commit Your Changes: Save your progress with a helpful message:
git add .
git commit -m "Added a new helper for list cleaning"
  1. Push to GitHub: Send your changes back to your fork:
git push origin my-new-feature
  1. Open a Pull Request: Go to the original py-simple-wrap repository on GitHub, and you'll see a button that says "Compare & pull request." Click it and tell me a bit about what you did!

💡 What should I contribute?

  • Report Bugs: If something isn't working, open an "Issue" and let me know.
  • New Ideas: Want to add a "Simple" module for math, strings, or colors? Open an Issue and we can brainstorm it together!
  • Documentation: Spot a typo in this README? I'd love for you to fix it!

Coding Style

I try to keep the code "Clean" and "Explicit."

  • Use descriptive function names (like is_file_there instead of check).
  • Always include Docstrings with an example.
  • Use existing helper functions (like is_valid_extension) to keep things consistent.

Thank you for being brave enough to try! I can't wait to see what you build. 🌈✨