cncf / cncf/project-template

Should we add MADR to project template?

Open
#39 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
82
Forks
47
PR merge metrics
No merged PRs in 30d

Description

We noticed that users and contributors of cloud native projects care a lot about *why* a certain technical decision was taken.

In our Kubernetes distribution, we use [Markdown Any Decision Records](https://github.com/adr/madr/). In essence, you create a folder `docs/adr` with a file `template.md`. Then you copy the template for each decision you take. [Here](https://github.com/elastisys/compliantkubernetes/tree/main/docs/adr) is an example on how this would look like.

Would it be beneficial to include this in the CNCF project template?

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the proposal for a `docs/adr` folder and `template.md`, then compare it with the linked compliantkubernetes example and the MADR reference. A complete outcome would define whether and how this project template should include decision records; the issue currently does not specify an implementation scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.