Skip to content

Commit

Permalink
Move docs structure explanation to dev docs and put ADRs in template …
Browse files Browse the repository at this point in the history
…docs
  • Loading branch information
callumforrester committed Jan 24, 2024
1 parent bfdc887 commit 9f1e397
Show file tree
Hide file tree
Showing 4 changed files with 68 additions and 0 deletions.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
% This Source Code Form is subject to the terms of the Mozilla Public

% License, v. 2.0. If a copy of the MPL was not distributed with this

% file, You can obtain one at http://mozilla.org/MPL/2.0/.

# Architectural Decision Records

We record major architectural decisions in Architecture Decision Records (ADRs),
as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
Below is the list of our current ADRs.

```{toctree}
:glob: true
:maxdepth: 1
decisions/*
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# 1. Record architecture decisions

Date: 2022-02-18

## Status

Accepted

## Context

We need to record the architectural decisions made on this project.

## Decision

We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).

## Consequences

See Michael Nygard's article, linked above. To create new ADRs we will copy and
paste from existing ones.
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# 2. Adopt python_copier_template for project structure

Date: 2022-02-18

## Status

Accepted

## Context

We should use the following [python_copier_template](https://github.com/DiamondLightSource/python-copier-template).
The template will ensure consistency in developer
environments and package management.

## Decision

We have switched to using the skeleton.

## Consequences

This module will use a fixed set of tools as developed in python_copier_template
and can pull from this template to update the packaging to the latest techniques.

As such, the developer environment may have changed, the following could be
different:

- linting
- formatting
- pip venv setup
- CI/CD

0 comments on commit 9f1e397

Please sign in to comment.