From 8e0bd851f0805d8031020f21ed9ddb61d0f608cb Mon Sep 17 00:00:00 2001 From: Sukesh Reddy Ustela <137488933+Suke2004@users.noreply.github.com> Date: Sun, 5 Oct 2025 13:39:21 +0530 Subject: [PATCH 1/2] docs: enhanced README for better contributor engagement and community interaction Improved the README design and content to make it more user-friendly and engaging. - Added interactive community and contributor sections - Enhanced visual appeal with badges and icons - Improved contribution guidance and clarity - Refined formatting for better readability This update aims to make onboarding smoother and encourage more contributions. --- README.md | 123 +++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 98 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 182d36a8d905..276245d1e63f 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,125 @@
- - - - -

The Algorithms - Python

- - + + + The Algorithms Logo + + +

🧩 The Algorithms β€” Python

+ +

+ A global open-source project where developers of all skill levels learn, code, and grow together β€” one algorithm at a time. +

+ + +

- Gitpod Ready-to-Code + Gitpod Ready - Contributions Welcome + Contributions Welcome - + Repo size - Discord chat + Discord Chat - Gitter chat + Gitter Community +

- -
+

- GitHub Workflow Status + GitHub CI - pre-commit + Pre-commit enabled - code style: black + Code style Ruff +

+ +

πŸ“š Learn. Contribute. Collaborate. Build your skills with real algorithms and open-source experience.

- -

All algorithms implemented in Python - for education πŸ“š

-Implementations are for learning purposes only. They may be less efficient than the implementations in the Python standard library. Use them at your discretion. +--- + +## 🧠 About the Project + +**The Algorithms – Python** is a learning-focused repository containing a variety of algorithms, data structures, and problem-solving approaches written in Python. +It’s a community effort to make algorithm learning more approachable and hands-on. + +πŸ’‘ Whether you’re a **beginner exploring your first pull request** or an **experienced developer refining your craft**, this project welcomes you! + +--- ## πŸš€ Getting Started -πŸ“‹ Read through our [Contribution Guidelines](CONTRIBUTING.md) before you contribute. +1. Read the [**Contribution Guidelines**](CONTRIBUTING.md) β€” they’ll help you set up your local environment and understand our workflow. +2. Pick an algorithm idea you’d like to implement or improve. +3. Submit your pull request β€” every contribution matters, no matter how small. + +> πŸ† **Tip:** Even fixing typos or improving documentation helps the project β€” and it counts toward open-source experience! + +--- + +## 🀝 How to Contribute + +We believe everyone can contribute β€” here’s how you can get involved: + +- 🧩 **Add a new algorithm or data structure** +- 🧠 **Optimize or refactor** an existing one +- 🧾 **Improve documentation** or code comments +- πŸ§ͺ **Add test cases** to increase reliability +- 🎨 **Enhance visuals or examples** for better understanding + +Check the [Issues tab](https://github.com/TheAlgorithms/Python/issues) β€” some are tagged with `good first issue` and are great starting points! + +--- + +## πŸŽ‰ Community Challenges -## 🌐 Community Channels +Want to go beyond code? Join our monthly **Algorithm Challenges** on Discord! +Each month we pick a topic (e.g., Sorting, Graphs, Dynamic Programming) and contributors compete in a friendly way to improve or implement related algorithms. -We are on [Discord](https://the-algorithms.com/discord) and [Gitter](https://gitter.im/TheAlgorithms/community)! Community channels are a great way for you to ask questions and get help. Please join us! +> 🧭 Participation badges and GitHub shoutouts are awarded to active contributors! -## πŸ“œ List of Algorithms +--- -See our [directory](DIRECTORY.md) for easier navigation and a better overview of the project. +## πŸ’¬ Join the Community + +Meet contributors, share knowledge, and learn collaboratively: + +- πŸ’» [Join our Discord](https://the-algorithms.com/discord) +- πŸ’‘ [Discuss on Gitter](https://gitter.im/TheAlgorithms/community) +- 🌎 [Follow The Algorithms](https://github.com/TheAlgorithms) + +We’re building not just a codebase β€” but a **learning community** that helps each other grow. + +--- + +## πŸ“‚ Explore Algorithms + +Browse through the [**Directory**](DIRECTORY.md) for all algorithm implementations, organized by topic and complexity level. +Each section includes beginner-friendly examples and explanations. + +--- + +## 🌟 Contributor Recognition + +Every contributor is a valuable part of this project. +We regularly feature top contributors and new members in our community newsletter. + +πŸ’¬ Join us β†’ contribute, learn, and get recognized! +You can also add yourself to the **Contributors Wall** once your PR is merged. + +--- + +
+ +🧑 Built with curiosity, collaboration, and community spirit by +The Algorithms Contributors + +
From f4f11f2a1f3a2b0c1d21cdc79e97b5174aa71a78 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sun, 5 Oct 2025 08:13:11 +0000 Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 276245d1e63f..d5bcfdef32ce 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ ## 🧠 About the Project -**The Algorithms – Python** is a learning-focused repository containing a variety of algorithms, data structures, and problem-solving approaches written in Python. +**The Algorithms – Python** is a learning-focused repository containing a variety of algorithms, data structures, and problem-solving approaches written in Python. It’s a community effort to make algorithm learning more approachable and hands-on. πŸ’‘ Whether you’re a **beginner exploring your first pull request** or an **experienced developer refining your craft**, this project welcomes you! @@ -57,8 +57,8 @@ It’s a community effort to make algorithm learning more approachable and hands ## πŸš€ Getting Started -1. Read the [**Contribution Guidelines**](CONTRIBUTING.md) β€” they’ll help you set up your local environment and understand our workflow. -2. Pick an algorithm idea you’d like to implement or improve. +1. Read the [**Contribution Guidelines**](CONTRIBUTING.md) β€” they’ll help you set up your local environment and understand our workflow. +2. Pick an algorithm idea you’d like to implement or improve. 3. Submit your pull request β€” every contribution matters, no matter how small. > πŸ† **Tip:** Even fixing typos or improving documentation helps the project β€” and it counts toward open-source experience! @@ -69,11 +69,11 @@ It’s a community effort to make algorithm learning more approachable and hands We believe everyone can contribute β€” here’s how you can get involved: -- 🧩 **Add a new algorithm or data structure** -- 🧠 **Optimize or refactor** an existing one -- 🧾 **Improve documentation** or code comments -- πŸ§ͺ **Add test cases** to increase reliability -- 🎨 **Enhance visuals or examples** for better understanding +- 🧩 **Add a new algorithm or data structure** +- 🧠 **Optimize or refactor** an existing one +- 🧾 **Improve documentation** or code comments +- πŸ§ͺ **Add test cases** to increase reliability +- 🎨 **Enhance visuals or examples** for better understanding Check the [Issues tab](https://github.com/TheAlgorithms/Python/issues) β€” some are tagged with `good first issue` and are great starting points! @@ -81,7 +81,7 @@ Check the [Issues tab](https://github.com/TheAlgorithms/Python/issues) β€” some ## πŸŽ‰ Community Challenges -Want to go beyond code? Join our monthly **Algorithm Challenges** on Discord! +Want to go beyond code? Join our monthly **Algorithm Challenges** on Discord! Each month we pick a topic (e.g., Sorting, Graphs, Dynamic Programming) and contributors compete in a friendly way to improve or implement related algorithms. > 🧭 Participation badges and GitHub shoutouts are awarded to active contributors! @@ -102,24 +102,24 @@ We’re building not just a codebase β€” but a **learning community** that helps ## πŸ“‚ Explore Algorithms -Browse through the [**Directory**](DIRECTORY.md) for all algorithm implementations, organized by topic and complexity level. +Browse through the [**Directory**](DIRECTORY.md) for all algorithm implementations, organized by topic and complexity level. Each section includes beginner-friendly examples and explanations. --- ## 🌟 Contributor Recognition -Every contributor is a valuable part of this project. +Every contributor is a valuable part of this project. We regularly feature top contributors and new members in our community newsletter. -πŸ’¬ Join us β†’ contribute, learn, and get recognized! +πŸ’¬ Join us β†’ contribute, learn, and get recognized! You can also add yourself to the **Contributors Wall** once your PR is merged. ---
-🧑 Built with curiosity, collaboration, and community spirit by +🧑 Built with curiosity, collaboration, and community spirit by The Algorithms Contributors