Document project development guidelines

[banjoh]

Describe the rationale for the suggested feature.

In addition to our contributing guidelines and design principles we need developer guidelines on how to actually write code when making contributions. Below is a non-exhaustive list of open things that need direction

• Logging conventions - What logs belong to which log level. This project uses klog so we can grab some inspiration from their logging conventions
  • Some documentation does exist in the code
• How to write tests - Helpful utilities such as the fake client, how far to go with your tests and what not to try writing tests for e.g no need to write integration tests that launch all sorts of databases if all that's needed is checking connectivity.
• High level guide on what code goes where e.g collectors live here etc
• Naming conventions - We should be fairly non-prescriptive here but things like support-bundle paths, names of collectors/analysers/redactors, specs and outputs of collectors would need some convention.
• ...

The aim is to have a guideline that is very light to consume, but with enough information to help developers get started in the right direction.