Midnighter / nf-core-adr

Structurizr documentation of nf-core

Home Page:https://structurizr.com/share/73218/decisions/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

nf-core Architecture Decisions

Documentation of architectural decisions - so called architecture decision records (ADR) - related to the module and pipeline template provided by the nf-core tools. ADRs should answer why certain decisions were made and provide the context for those decisions at the time.

Usage

In order to add new records, we recommend the adr-tools; to modify them, a simple editor will do. Any changes merged into the main branch are automatically uploaded and visualized in the Structurizr workspace.

Contributing

I'm not a member of the nf-core team. As such, I was neither present for most of the decision, nor do I know their context well. I'm merely trying to document them retroactively to further my own understanding and for the benefit of others. Hopefully, this will proove to be a valuable resource and encourage the nf-core team to document future decisions in the same manner. Any corrections or missing decisions that you can contribute in the form of pull requests or issues about them are most welcome. You can also contact me on the nf-core Slack.

Copyright

CC0 Public Domain
To the extent possible under law, the person who associated CC0 with this work has waived all copyright and related or neighboring rights to this work.

About

Structurizr documentation of nf-core

https://structurizr.com/share/73218/decisions/

License:Creative Commons Zero v1.0 Universal


Languages

Language:ASL 100.0%