Write an ADR in this format to record how we've decided to manage the .devcontainer configuration.
[!NOTE]
Please read Michael Nygard's blog post about how to document an architecture decision first.
Rough outline of the decision
The .devcontainer directory within the research-template repo is the responsibility of Team REX.
We will keep our changes contained to this directory where possible, rather than making changes to other files within the research-template repo.
Where possible, we will also move things into the Docker image rather than the research-template repo, so that it’s easier for us to get changes out to researchers. Things that change often should be in the docker image.
We expect to be making changes to this directory in future.
Some consequences
When the .devcontainer directory is copied into the researcher’s repo, we expect to provide some support for it.
We’ve provided manual instructions for researchers to do this. We haven’t automated it (yet), as there are still some unknowns around this process and want to learn more.
Write an ADR in this format to record how we've decided to manage the .devcontainer configuration.
Rough outline of the decision
The .devcontainer directory within the research-template repo is the responsibility of Team REX.
We will keep our changes contained to this directory where possible, rather than making changes to other files within the research-template repo.
Where possible, we will also move things into the Docker image rather than the research-template repo, so that it’s easier for us to get changes out to researchers. Things that change often should be in the docker image.
We expect to be making changes to this directory in future.
Some consequences
When the .devcontainer directory is copied into the researcher’s repo, we expect to provide some support for it.
We’ve provided manual instructions for researchers to do this. We haven’t automated it (yet), as there are still some unknowns around this process and want to learn more.