opensafely-core / codespaces-initiative

Improving the use of OpenSAFELY in Codespaces
MIT License
0 stars 0 forks source link

ADR: Using the separate research-template-docker repo #63

Closed lucyb closed 4 months ago

lucyb commented 4 months ago

Write an ADR in this format to record why we're using the separate research-template-docker repo and what the consequences of this decision are.

[!NOTE] Please read Michael Nygard's blog post about how to document an architecture decision first.

The decision should briefly explain the purpose of the two repos:

The research-template repo contains

  • The code and configuration to be copied into a researcher’s repo

The research-template-docker repo contains

  • The Docker image used to provide the dev container environment
  • The tooling and GitHub actions to build the Docker image
  • Some of the supporting files for the research-template (e.g tests and ADRs).

It should also mention that we’ve decided not to add files into the research-template repo that aren’t directly used by the researcher. For example, this ADR is in the research-template-docker repo rather than the research-template repo.