Skip to content

Instantly share code, notes, and snippets.

View yss14's full-sized avatar

Yannick Stachelscheid yss14

View GitHub Profile
@yss14
yss14 / clean_code_checklist.md
Last active January 6, 2019 18:51
Brief summary of smells and heuristics to keep code clean, prepared as a github markdown checklist

First, and most important: A professional software developer should always leave a module a little cleaner than you found it so that it becomes easier to change over time, not harder. Suitable automated tests can allow you to not be afraid to change the code and continually changing it makes sure it stays that way.

1 General

  • No dead code (just remove it - git keeps track of it; there can be dead code the compiler does not recognize mostyl because of conditions never evaluating to true)
  • Obvious behaviour is implemented (a class or function should implement what the name of the class or functions says, nothing more, nothing less)
  • No safeties are overriden (don't disable compiler warnings, don't comment out not working tests - fix them!)
  • No code duplications (every duplication represents a missed opportunity for abstraction)
  • Vertical Separation (variables and functions should be defined close to there they are used; local vars just declared where they are used first; prive func
@yss14
yss14 / gist:47808a674dc33b0f7a15f810098d6ba9
Last active December 18, 2017 16:05
AI driven chatbot development guide

AI driven chatbot development guide

Preparations

Download and install

To be able to deploy your chatbot later on and getting the Microsoft Bot Framework code template, we first need an Microsoft Azure Account. Therefore, please go to www.microsoftazurepass.com and login with your existing Microsoft Account or create a new one. If logged in, proceed until you are asked for the Azure Pass Promo Code. Enter your provided promotion code and click on "Claim Promo Code".