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.
- Fork the repository.
- 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
- For example if you are adding a smell / heuristic about 'naming' then add it to the
- Ensure that the markdown file has front-matter that defines
code
andtitle
variables.The new file will be automatically organised on the page according to its collection and code.--- code: C1 title: Re-iterating The Code ---
- Add code examples, they can be in any language
- Submit a PR.
- Create a new folder with with a leading underscore.
- Update
_config.yml
to register the folder as a collection.
Follow the instructions in the Setting up your GitHub Pages site locally with Jekyll article.
bundle install
bundle exec jekyll serve
open localhost:4000