{"id":13604043,"url":"https://github.com/homostellaris/clean-code-smells-and-heuristics","last_synced_at":"2025-04-11T22:32:26.949Z","repository":{"id":40008441,"uuid":"167074954","full_name":"homostellaris/clean-code-smells-and-heuristics","owner":"homostellaris","description":"A linkable reference of code smells \u0026 heuristics for better code reviews, inspired by the chapter of the same name in Bob Martin's \"Clean Code\".","archived":false,"fork":false,"pushed_at":"2024-09-17T20:01:56.000Z","size":98,"stargazers_count":25,"open_issues_count":3,"forks_count":11,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-07T08:41:56.801Z","etag":null,"topics":["clean-code","code-smells","heuristics","reference"],"latest_commit_sha":null,"homepage":"https://homostellaris.github.io/clean-code-smells-and-heuristics/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/homostellaris.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-22T22:08:19.000Z","updated_at":"2024-09-18T07:34:19.000Z","dependencies_parsed_at":"2024-01-16T23:29:00.177Z","dependency_job_id":"c2f8c549-9980-40d3-a743-9b83ccfdf8e0","html_url":"https://github.com/homostellaris/clean-code-smells-and-heuristics","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/homostellaris%2Fclean-code-smells-and-heuristics","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/homostellaris%2Fclean-code-smells-and-heuristics/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/homostellaris%2Fclean-code-smells-and-heuristics/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/homostellaris%2Fclean-code-smells-and-heuristics/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/homostellaris","download_url":"https://codeload.github.com/homostellaris/clean-code-smells-and-heuristics/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248489854,"owners_count":21112652,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clean-code","code-smells","heuristics","reference"],"created_at":"2024-08-01T19:00:38.804Z","updated_at":"2025-04-11T22:32:25.835Z","avatar_url":"https://github.com/homostellaris.png","language":"HTML","funding_links":[],"categories":["HTML"],"sub_categories":[],"readme":"# Clean Code Smells \u0026 Heuristics: Community Edition ✨\n\nhttps://homostellaris.github.io/clean-code-smells-and-heuristics/\n\nWe encourage you to submit PRs to add to this database of smells \u0026 heuristics so that yourself and others can\nbenefit. Otherwise you are free to make a hard fork and use this repo as a template to start your own from scratch.\n\n# Adding a new smell / heuristic\n\n1. Fork the repository.\n1. Create a new markdown file in the folder for the relevant collection.\n   - For example if you are adding a smell / heuristic about 'naming' then add it to the `_naming` folder.\n   - If you want to create a new collection then refer to [Adding a new collection](#adding-a-new-collection)\n1. Ensure that the markdown file has front-matter that defines `code` and `title` variables.\n   ```\n   ---\n   code: C1\n   title: Re-iterating The Code\n   ---\n   ```\n   The new file will be automatically organised on the page according to its collection and code.\n1. Add code examples, they can be in any language\n1. Submit a PR.\n\n# Adding a new collection\n\n1. Create a new folder with with a leading underscore.\n2. Update `_config.yml` to register the folder as a collection.\n\n# Getting started with development\n\nFollow the instructions in the [Setting up your GitHub Pages site locally with Jekyll](https://help.github.com/en/articles/setting-up-your-github-pages-site-locally-with-jekyll) article.\n\n## TL; DR\n\n1. `bundle install`\n2. `bundle exec jekyll serve`\n3. `open localhost:4000`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhomostellaris%2Fclean-code-smells-and-heuristics","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhomostellaris%2Fclean-code-smells-and-heuristics","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhomostellaris%2Fclean-code-smells-and-heuristics/lists"}