Skip to content

Doc software - #6

Merged
folterj merged 13 commits into
mainfrom
doc-software
Sep 2, 2026
Merged

folterj merged 13 commits into
mainfrom
doc-software

Conversation

@folterj

@folterj folterj commented Aug 31, 2026

Copy link
Copy Markdown
Member

Updated documentation with remaining sections

@folterj
folterj requested review from M-A-Demir and piperfw August 31, 2026 17:15
Comment thread docs/green.md Resolved
Comment thread docs/software.md Resolved
Comment thread docs/software.md Resolved
* which parts of the work it assisted with;
* whether generated output was modified;
* how a human reviewed, tested and validated the result.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to add a note alongide the above, you can append a Co-Authored by: string to your commit messages for complete traceability
?

Comment thread docs/software_publishing.md Outdated
* Start from a minimal, actively maintained base image and record why it was
chosen. Reuse an established base image, such as an official Python or CUDA
image, instead of building an environment from scratch.
* Pin what you depend on: the base image tag, and ideally its digest; the

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In principal pinning ensures reproducibility, in practice the build will just fail within days/weeks due to upstream availability.

I suggest we rephrase this point to pin more strategically. Let me know if you want me to suggest a replacement

Comment thread docs/software_publishing.md Resolved
Comment thread docs/software.md Resolved
folterj and others added 4 commits September 2, 2026 10:53
Co-authored-by: Piper Fowler-Wright <piperfw@gmail.com>
Co-authored-by: Piper Fowler-Wright <piperfw@gmail.com>
Co-authored-by: Piper Fowler-Wright <piperfw@gmail.com>
Co-authored-by: Piper Fowler-Wright <piperfw@gmail.com>
Comment thread docs/software_publishing.md Resolved
Comment thread docs/software_publishing.md Resolved
Comment thread docs/software_publishing.md Resolved
folterj and others added 3 commits September 2, 2026 11:21
Co-authored-by: Piper Fowler-Wright <piperfw@gmail.com>
Co-authored-by: Piper Fowler-Wright <piperfw@gmail.com>
Co-authored-by: Piper Fowler-Wright <piperfw@gmail.com>
@folterj
folterj merged commit 173939b into main Sep 2, 2026
1 check passed
@folterj
folterj deleted the doc-software branch September 2, 2026 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants