Skip to content

Improve README interactivity and contributor engagement (fixes #13111, #13076) #13213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Improve README interactivity and contributor engagement (fixes #13111, #13076) #13213

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e0bd85
docs: enhanced README for better contributor engagement and community…
Suke2004 Oct 5, 2025
f4f11f2
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 98 additions & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,52 +1,125 @@
<div align="center">
<!-- Title: -->
<a href="https://github.com/TheAlgorithms/">
<img src="https://raw.githubusercontent.com/TheAlgorithms/website/1cd824df116b27029f17c2d1b42d81731f28a920/public/logo.svg" height="100">
</a>
<h1><a href="https://github.com/TheAlgorithms/">The Algorithms</a> - Python</h1>

<!-- Labels: -->
<!-- First row: -->
<!-- Logo -->
<a href="https://github.com/TheAlgorithms/">
<img src="https://raw.githubusercontent.com/TheAlgorithms/website/1cd824df116b27029f17c2d1b42d81731f28a920/public/logo.svg" height="100" alt="The Algorithms Logo">
</a>

<h1>🧩 The Algorithms — Python</h1>

<p>
A global open-source project where developers of all skill levels learn, code, and grow together — one algorithm at a time.
</p>

<!-- Badges -->
<p>
<a href="https://gitpod.io/#https://github.com/TheAlgorithms/Python">
<img src="https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod&style=flat-square" height="20" alt="Gitpod Ready-to-Code">
<img src="https://img.shields.io/badge/Gitpod-Ready%20to%20Code-blue?logo=gitpod&style=for-the-badge" alt="Gitpod Ready">
</a>
<a href="https://github.com/TheAlgorithms/Python/blob/master/CONTRIBUTING.md">
<img src="https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat-square" height="20" alt="Contributions Welcome">
<img src="https://img.shields.io/badge/Contributions-Welcome-brightgreen?style=for-the-badge" alt="Contributions Welcome">
</a>
<img src="https://img.shields.io/github/repo-size/TheAlgorithms/Python.svg?label=Repo%20size&style=flat-square" height="20">
<img src="https://img.shields.io/github/repo-size/TheAlgorithms/Python?label=Repo%20Size&style=for-the-badge" alt="Repo size">
<a href="https://the-algorithms.com/discord">
<img src="https://img.shields.io/discord/808045925556682782.svg?logo=discord&colorB=7289DA&style=flat-square" height="20" alt="Discord chat">
<img src="https://img.shields.io/discord/808045925556682782.svg?logo=discord&colorB=7289DA&label=Join%20Discord&style=for-the-badge" alt="Discord Chat">
</a>
<a href="https://gitter.im/TheAlgorithms/community">
<img src="https://img.shields.io/badge/Chat-Gitter-ff69b4.svg?label=Chat&logo=gitter&style=flat-square" height="20" alt="Gitter chat">
<img src="https://img.shields.io/badge/Community-Gitter-ff69b4?logo=gitter&style=for-the-badge" alt="Gitter Community">
</a>
</p>

<!-- Second row: -->
<br>
<p>
<a href="https://github.com/TheAlgorithms/Python/actions">
<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">
<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">
</a>
<a href="https://github.com/pre-commit/pre-commit">
<img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" height="20" alt="pre-commit">
<img src="https://img.shields.io/badge/pre--commit-Enabled-brightgreen?logo=pre-commit&style=flat-square" alt="Pre-commit enabled">
</a>
<a href="https://docs.astral.sh/ruff/formatter/">
<img src="https://img.shields.io/static/v1?label=code%20style&message=ruff&color=black&style=flat-square" height="20" alt="code style: black">
<img src="https://img.shields.io/badge/Code%20Style-Ruff-black?style=flat-square" alt="Code style Ruff">
</a>
</p>

<h3>📚 Learn. Contribute. Collaborate. Build your skills with real algorithms and open-source experience.</h3>

<!-- Short description: -->
<h3>All algorithms implemented in Python - for education 📚</h3>
</div>

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.

---

<div align="center">

🧡 Built with curiosity, collaboration, and community spirit by
<a href="https://github.com/TheAlgorithms/">The Algorithms Contributors</a>

</div>