Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate a checklist from all recommendations #1

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Conversation

ruuda
Copy link
Contributor

@ruuda ruuda commented May 29, 2024

This adds a small script that collects the recommendations from all chapters and puts them together in a markdown checklist.

We can use this checklist internally for tech due diligence (copy it into a GitHub issue, check the boxes where applicable). It’s not yet complete (e.g. a key management chapter is missing) and often it’s not possible to give a clear yes/no answer, but it can be a starting point, and serve as an overview where we can see at a glance “Red flags, many P0/P1 missing” vs. “P0/P1 all satisfied + some green flags”.

Note for reviewers, this repository is intended to be public!

ruuda added 4 commits May 29, 2024 10:33
For our internal tech due diligence, we currently have some checklist,
but it would be nice to have one that is in sync with this book
automatically. We can autogenerate a checklist from the headings.
@ruuda ruuda requested a review from jenpaff May 29, 2024 11:13
I accidentally relied on file system ordering, and it's different
between CI and my laptop.
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.

1 participant