Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleWhy is this extremely important?

This is extremely important because you don’t want to spend a week time on a Pull Request only to find out that it has to be completely redone because of its core design. There Also, there will always be improvements underway in the CHEFS code, and any new work must align with those improvements - so following the existing design might not be the best approach. The end goal of these improvements is code that is:

  • necessary (YAGNI - don’t maintain, document, test, etc, code that we don’t need)

  • correct (it should work!)

  • simple (“as simple as possible but no simpler”)

  • documented

  • easy to read

  • easy to understand

  • easy to modify

  • easy to fully test

  • consistent (to reduce cognitive load)

Information that everyone should be familiar with:

...