https://github.com/homostellaris/clean-code-smells-and-heuristics

A linkable reference of code smells & heuristics for better code reviews, inspired by the chapter of the same name in Bob Martin's "Clean Code".
https://github.com/homostellaris/clean-code-smells-and-heuristics

clean-code code-smells heuristics reference

Last synced: 3 months ago
JSON representation

A linkable reference of code smells & heuristics for better code reviews, inspired by the chapter of the same name in Bob Martin's "Clean Code".

• Host: GitHub
• URL: https://github.com/homostellaris/clean-code-smells-and-heuristics
• Owner: homostellaris
• Created: 2019-01-22T22:08:19.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-09-17T20:01:56.000Z (4 months ago)
• Last Synced: 2024-09-18T00:21:52.137Z (4 months ago)
• Topics: clean-code, code-smells, heuristics, reference
• Language: HTML
• Homepage: https://homostellaris.github.io/clean-code-smells-and-heuristics/
• Size: 95.7 KB
• Stars: 24
• Watchers: 1
• Forks: 11
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-list - homostellaris/clean-code-smells-and-heuristics - A linkable reference of code smells & heuristics for better code reviews, inspired by the chapter of the same name in Bob Martin's "Clean Code". (HTML)

README

        
# Clean Code Smells & Heuristics: Community Edition ✨

https://homostellaris.github.io/clean-code-smells-and-heuristics/

We encourage you to submit PRs to add to this database of smells & heuristics so that yourself and others can

benefit. Otherwise you are free to make a hard fork and use this repo as a template to start your own from scratch.

# Adding a new smell / heuristic

1. Fork the repository.

1. Create a new markdown file in the folder for the relevant collection.

   - For example if you are adding a smell / heuristic about 'naming' then add it to the `_naming` folder.

   - If you want to create a new collection then refer to [Adding a new collection](#adding-a-new-collection)

1. Ensure that the markdown file has front-matter that defines `code` and `title` variables.

   ```

   ---

   code: C1

   title: Re-iterating The Code

   ---

   ```

   The new file will be automatically organised on the page according to its collection and code.

1. Add code examples, they can be in any language

1. Submit a PR.

# Adding a new collection

1. Create a new folder with with a leading underscore.

2. Update `_config.yml` to register the folder as a collection.

# Getting started with development

Follow 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.

## TL; DR

1. `bundle install`

2. `bundle exec jekyll serve`

3. `open localhost:4000`