diff --git a/README.md b/README.md index 182d36a8d905..465f088b1e75 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,50 @@ -
+# The Algorithms - Python + +**All Algorithms implemented in Python - for education 📚** + + + +[](https://discord.gg/c7gVnC6) +[](https://gitter.im/TheAlgorithms) Implementations are for learning purposes only. They may be less efficient than the implementations in the Python standard library. Use them at your discretion. +*** + ## 🚀 Getting Started -📋 Read through our [Contribution Guidelines](CONTRIBUTING.md) before you contribute. +📋 Read through our **[Contribution Guidelines](CONTRIBUTING.md)** before you contribute. + +**This is the single most important document you must read before submitting a Pull Request (PR).** + +*** ## 🌐 Community Channels -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! +We are on **Discord** and **Gitter**! Community channels are a great way for you to ask questions and get help. Please join us! + +*** ## 📜 List of Algorithms -See our [directory](DIRECTORY.md) for easier navigation and a better overview of the project. +See our **[directory (DIRECTORY.md)](DIRECTORY.md)** for easier navigation and a better overview of the project structure and all available algorithms. + +*** + +## About + +* **Website:** [thealgorithms.github.io/Python/](https://thealgorithms.github.io/Python/) +* **Topics:** `python` `education` `algorithm` `practice` `interview` `sorting-algorithms` `learn` `algos` `algorithm-competitions` `sorts` `hacktoberfest` `algorithms-implemented` `community-driven` `searches` +* **License:** [MIT License](LICENSE.md) +* **Code of Conduct:** [Code of conduct](CODE_OF_CONDUCT.md) +* **Contributors:** 1,258+ + +*** + +## 💡 How to Contribute (Hacktoberfest Focus) + +This project is massive, so your best way to contribute for Hacktoberfest is to find a small, defined task: + +1. **Look for Open Issues:** Check the repository's **Issues** page and filter by the labels **`good first issue`** or **`help wanted`**. +2. **Add a New Algorithm:** If you know a popular algorithm not yet implemented, you can write the Python code for it, ensuring it follows the style and includes tests as required in the **`CONTRIBUTING.md`**. +3. **Improve Documentation/Tests:** Add **doctests** or comprehensive unit tests for an existing algorithm file