BBC Maestro engineering handbook

Welcome to the engineering handbook for BBC Maestro. This collection of documentation serves to codify how we work as a team.

Scope

What is laid out here covers our approach to processes and workflows – much of which is consistent across projects. Individual codebases will document the exact development workflow for their specific contexts, complementing the higher-level guidance here with application-specific instructions and relevant deviations.

In the case of conflicting guidance, refer to the most local documentation.

Visibility

These docs are public (hello, stranger 👋). Because they are publicly viewable, this holds us to a higher level of scrutiny and accountability. Certain steps should be taken to ensure the content is suitable to be shared publicly. This includes, but is not limited to:

• Never sharing sensitive URLs
• Never displaying any real customer data
• Never naming employee names
• Never sharing secure credentials
• Not being overly specific with systems, identifiers, or screenshots

Contributing

• Each page has an "edit this page" link that will take you to the markdown file on Github where you can make changes in the Github UI. Equally, it's a git repo, so you can clone it and run it locally.
• If you want to make a change to some guidance or process, raising a PR is a good idea. That enables us to discuss the change, and have a paper trail when it lands.