“Always leave the campground cleaner than you found it.” - BOY SCOUTS RULE

Campground refers to the collection of more mundane dev tasks for general code quality, from an initial review of BB.

Testing Guidelines

Clean Github Repo

DONE

Lots of branches, PRs and issues that need to be reduced. Really hard to know where to start with so much changing.

Best thing seems to be we do the reviews so that unneccessary branches can be cleaned up ASAP

Code Coverage and Test Suite

IN PROGRESS

We have very low code coverage, it's fine for a prototype, but we're going to be deploying to live customers soon, so:

• Aims:

  • Achieve, say, 90% coverage before EoY
  • No bullshit tests, get the interface tested, above and beyond private methods
  • Get some decent integration and E2E tests in place

• It's easy to knock coverage, but coverage targets do ensure at least some care and attention is taken to:

  • Writing testable code
  • Having some degree of stability when it comes to integrating features
  • It's still on the developer to write useful tests

Campground work here:

• Start tracking coverage and surface in standups

Documentation

ONGOING

The project documentation is really good on BB, I think the developer documentation should also be good.

• As a guest pass, I can't be bothered to run all my edits through GH PRs, so I think notion is a great alternative that anyone can contribute to.