Architectural Decisions Records

[gilesknap]

first draft of ADRs for python3-pip-skeleton.

• Added ADRs 3 to 12
• moved pre-commit explanation to ADR0008 on pre-commit and tox
• moved using src explanation to ADR0004
• moved docs structure explanation to ADR0003
• moved ADRs to user explanations

remaining work is captured in this whiteboard

[gilesknap]

You can see the built docs here https://diamondlightsource.github.io/python3-pip-skeleton-cli/dev/user/explanations/decisions.html

[codecov]

Codecov Report

Merging #62 (ad056f9) into main (2072ea6) will not change coverage.
The diff coverage is 100.00%.

❗ Current head ad056f9 differs from pull request most recent head 613d09c. Consider uploading reports for the commit 613d09c to get more accurate results

@@            Coverage Diff            @@
##              main       #62   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines          138       135    -3     
=========================================
- Hits           138       135    -3     

Impacted Files	Coverage Δ
src/python3_pip_skeleton/__init__.py	100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[gilesknap]

@coretl while we are at this. Are we happy that the project is called python3-pip-skeleton-cli but the package is python3-pip-skeleton? It may be a little confusing and I did get asked about it this week. At the same time I like that the published package is called python3-pip-skeleton so not sure....

[gilesknap]

@coretl I've added developer howto test container.

I think I'm done with the whiteboard points now. Let me know if you are happy to merge.