Welcome to this repository!
The code examples contained in these files are designed to demonstrate common code smells-patterns in code that often indicate deeper problems affecting readability, maintainability, or performance. Each example highlights a specific code smell and provides a corresponding refactored version to show how to effectively fix or improve the code.
NOTE: This repository contains intentionally poor code examples These are used for educational purposes as part of a Code Smells and Refactoring workshop.
The goal of this repository is to help developers learn how to identitfy, discuss, and refactor various code smells that reduce code quality, manitaninability, and readability.
- Illustrate typical code smells encountered in real-world programming.
- Provide clear, practical examples of how to identify these smells.
- Showcase best practices and techniques to refactor and improve code quality.
- No sensitive or production code is used.
- All examples are educational.
- Browse through the example files to learn about different code smells.
- Compare the "before" (smelly) and "after" (clean) versions to understand the improvements.
- Use these examples as a learning tool to recognize and fix code smells in your own projects.
Participants or reviewers can clone this repository to explore .
-
reddit.com/r/learnprogramming/all_code_smells_oneliner_guide (this is also pastebinned in a file called additionalNotes inside this repo)
-
"Refactoring: Improving the Design of Existing Code" by Martin Fowler and Kent Beck
-
"Clean Code" by Robert C. Martin
Feel free to explore, learn, and contribute! If you find new smells or better fixes, your pull requests are welcome.
Happy coding! 🚀
See LICENSE