Should we add MADR to project template?

cncf / project-template

CNCF Project Template

https://cncf.io/projects

Apache License 2.0

63 stars 48 forks source link

Should we add MADR to project template? #39

Open cristiklein opened 1 year ago

cristiklein commented 1 year ago

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. In essence, you create a folder docs/adr with a file template.md. Then you copy the template for each decision you take. Here is an example on how this would look like.

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

jberkus commented 1 year ago

We have a draft in progress covering Design Proposals, which is the other name for this. I wasn't previously aware that there were any standard formats for such things, so thanks for that!

Feel free to comment on the open PR?

cristiklein commented 1 year ago

@jberkus Sorry for the radio silence. I was busy before holidays, then I was on holidays.

I just noticed that the PR you refer to got merged. Shall I open a new PR and let people comment on it?