|
1 | 1 | <div align="center"> |
2 | | -<!-- Title: --> |
3 | | - <a href="https://github.com/TheAlgorithms/"> |
4 | | - <img src="https://raw.githubusercontent.com/TheAlgorithms/website/1cd824df116b27029f17c2d1b42d81731f28a920/public/logo.svg" height="100"> |
5 | | - </a> |
6 | | - <h1><a href="https://github.com/TheAlgorithms/">The Algorithms</a> - Python</h1> |
7 | 2 |
|
8 | | -<!-- Labels: --> |
9 | | - <!-- First row: --> |
| 3 | +<!-- Logo --> |
| 4 | +<a href="https://github.com/TheAlgorithms/"> |
| 5 | + <img src="https://raw.githubusercontent.com/TheAlgorithms/website/1cd824df116b27029f17c2d1b42d81731f28a920/public/logo.svg" height="100" alt="The Algorithms Logo"> |
| 6 | +</a> |
| 7 | + |
| 8 | +<h1>🧩 The Algorithms — Python</h1> |
| 9 | + |
| 10 | +<p> |
| 11 | + A global open-source project where developers of all skill levels learn, code, and grow together — one algorithm at a time. |
| 12 | +</p> |
| 13 | + |
| 14 | +<!-- Badges --> |
| 15 | +<p> |
10 | 16 | <a href="https://gitpod.io/#https://github.com/TheAlgorithms/Python"> |
11 | | - <img src="https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod&style=flat-square" height="20" alt="Gitpod Ready-to-Code"> |
| 17 | + <img src="https://img.shields.io/badge/Gitpod-Ready%20to%20Code-blue?logo=gitpod&style=for-the-badge" alt="Gitpod Ready"> |
12 | 18 | </a> |
13 | 19 | <a href="https://github.com/TheAlgorithms/Python/blob/master/CONTRIBUTING.md"> |
14 | | - <img src="https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat-square" height="20" alt="Contributions Welcome"> |
| 20 | + <img src="https://img.shields.io/badge/Contributions-Welcome-brightgreen?style=for-the-badge" alt="Contributions Welcome"> |
15 | 21 | </a> |
16 | | - <img src="https://img.shields.io/github/repo-size/TheAlgorithms/Python.svg?label=Repo%20size&style=flat-square" height="20"> |
| 22 | + <img src="https://img.shields.io/github/repo-size/TheAlgorithms/Python?label=Repo%20Size&style=for-the-badge" alt="Repo size"> |
17 | 23 | <a href="https://the-algorithms.com/discord"> |
18 | | - <img src="https://img.shields.io/discord/808045925556682782.svg?logo=discord&colorB=7289DA&style=flat-square" height="20" alt="Discord chat"> |
| 24 | + <img src="https://img.shields.io/discord/808045925556682782.svg?logo=discord&colorB=7289DA&label=Join%20Discord&style=for-the-badge" alt="Discord Chat"> |
19 | 25 | </a> |
20 | 26 | <a href="https://gitter.im/TheAlgorithms/community"> |
21 | | - <img src="https://img.shields.io/badge/Chat-Gitter-ff69b4.svg?label=Chat&logo=gitter&style=flat-square" height="20" alt="Gitter chat"> |
| 27 | + <img src="https://img.shields.io/badge/Community-Gitter-ff69b4?logo=gitter&style=for-the-badge" alt="Gitter Community"> |
22 | 28 | </a> |
| 29 | +</p> |
23 | 30 |
|
24 | | - <!-- Second row: --> |
25 | | - <br> |
| 31 | +<p> |
26 | 32 | <a href="https://github.com/TheAlgorithms/Python/actions"> |
27 | | - <img src="https://img.shields.io/github/actions/workflow/status/TheAlgorithms/Python/build.yml?branch=master&label=CI&logo=github&style=flat-square" height="20" alt="GitHub Workflow Status"> |
| 33 | + <img src="https://img.shields.io/github/actions/workflow/status/TheAlgorithms/Python/build.yml?branch=master&label=Build&logo=github&style=flat-square" alt="GitHub CI"> |
28 | 34 | </a> |
29 | 35 | <a href="https://github.com/pre-commit/pre-commit"> |
30 | | - <img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" height="20" alt="pre-commit"> |
| 36 | + <img src="https://img.shields.io/badge/pre--commit-Enabled-brightgreen?logo=pre-commit&style=flat-square" alt="Pre-commit enabled"> |
31 | 37 | </a> |
32 | 38 | <a href="https://docs.astral.sh/ruff/formatter/"> |
33 | | - <img src="https://img.shields.io/static/v1?label=code%20style&message=ruff&color=black&style=flat-square" height="20" alt="code style: black"> |
| 39 | + <img src="https://img.shields.io/badge/Code%20Style-Ruff-black?style=flat-square" alt="Code style Ruff"> |
34 | 40 | </a> |
| 41 | +</p> |
| 42 | + |
| 43 | +<h3>📚 Learn. Contribute. Collaborate. Build your skills with real algorithms and open-source experience.</h3> |
35 | 44 |
|
36 | | -<!-- Short description: --> |
37 | | - <h3>All algorithms implemented in Python - for education 📚</h3> |
38 | 45 | </div> |
39 | 46 |
|
40 | | -Implementations are for learning purposes only. They may be less efficient than the implementations in the Python standard library. Use them at your discretion. |
| 47 | +--- |
| 48 | + |
| 49 | +## 🧠 About the Project |
| 50 | + |
| 51 | +**The Algorithms – Python** is a learning-focused repository containing a variety of algorithms, data structures, and problem-solving approaches written in Python. |
| 52 | +It’s a community effort to make algorithm learning more approachable and hands-on. |
| 53 | + |
| 54 | +💡 Whether you’re a **beginner exploring your first pull request** or an **experienced developer refining your craft**, this project welcomes you! |
| 55 | + |
| 56 | +--- |
41 | 57 |
|
42 | 58 | ## 🚀 Getting Started |
43 | 59 |
|
44 | | -📋 Read through our [Contribution Guidelines](CONTRIBUTING.md) before you contribute. |
| 60 | +1. Read the [**Contribution Guidelines**](CONTRIBUTING.md) — they’ll help you set up your local environment and understand our workflow. |
| 61 | +2. Pick an algorithm idea you’d like to implement or improve. |
| 62 | +3. Submit your pull request — every contribution matters, no matter how small. |
| 63 | + |
| 64 | +> 🏆 **Tip:** Even fixing typos or improving documentation helps the project — and it counts toward open-source experience! |
| 65 | +
|
| 66 | +--- |
| 67 | + |
| 68 | +## 🤝 How to Contribute |
| 69 | + |
| 70 | +We believe everyone can contribute — here’s how you can get involved: |
| 71 | + |
| 72 | +- 🧩 **Add a new algorithm or data structure** |
| 73 | +- 🧠 **Optimize or refactor** an existing one |
| 74 | +- 🧾 **Improve documentation** or code comments |
| 75 | +- 🧪 **Add test cases** to increase reliability |
| 76 | +- 🎨 **Enhance visuals or examples** for better understanding |
| 77 | + |
| 78 | +Check the [Issues tab](https://github.com/TheAlgorithms/Python/issues) — some are tagged with `good first issue` and are great starting points! |
| 79 | + |
| 80 | +--- |
| 81 | + |
| 82 | +## 🎉 Community Challenges |
45 | 83 |
|
46 | | -## 🌐 Community Channels |
| 84 | +Want to go beyond code? Join our monthly **Algorithm Challenges** on Discord! |
| 85 | +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. |
47 | 86 |
|
48 | | -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! |
| 87 | +> 🧭 Participation badges and GitHub shoutouts are awarded to active contributors! |
49 | 88 |
|
50 | | -## 📜 List of Algorithms |
| 89 | +--- |
51 | 90 |
|
52 | | -See our [directory](DIRECTORY.md) for easier navigation and a better overview of the project. |
| 91 | +## 💬 Join the Community |
| 92 | + |
| 93 | +Meet contributors, share knowledge, and learn collaboratively: |
| 94 | + |
| 95 | +- 💻 [Join our Discord](https://the-algorithms.com/discord) |
| 96 | +- 💡 [Discuss on Gitter](https://gitter.im/TheAlgorithms/community) |
| 97 | +- 🌎 [Follow The Algorithms](https://github.com/TheAlgorithms) |
| 98 | + |
| 99 | +We’re building not just a codebase — but a **learning community** that helps each other grow. |
| 100 | + |
| 101 | +--- |
| 102 | + |
| 103 | +## 📂 Explore Algorithms |
| 104 | + |
| 105 | +Browse through the [**Directory**](DIRECTORY.md) for all algorithm implementations, organized by topic and complexity level. |
| 106 | +Each section includes beginner-friendly examples and explanations. |
| 107 | + |
| 108 | +--- |
| 109 | + |
| 110 | +## 🌟 Contributor Recognition |
| 111 | + |
| 112 | +Every contributor is a valuable part of this project. |
| 113 | +We regularly feature top contributors and new members in our community newsletter. |
| 114 | + |
| 115 | +💬 Join us → contribute, learn, and get recognized! |
| 116 | +You can also add yourself to the **Contributors Wall** once your PR is merged. |
| 117 | + |
| 118 | +--- |
| 119 | + |
| 120 | +<div align="center"> |
| 121 | + |
| 122 | +🧡 Built with curiosity, collaboration, and community spirit by |
| 123 | +<a href="https://github.com/TheAlgorithms/">The Algorithms Contributors</a> |
| 124 | + |
| 125 | +</div> |
0 commit comments