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

Should we add MADR to project template? #39

Open
cristiklein opened this issue Apr 19, 2023 · 2 comments
Open

Should we add MADR to project template? #39

cristiklein opened this issue Apr 19, 2023 · 2 comments

Comments

@cristiklein
Copy link

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
Copy link
Collaborator

jberkus commented Jun 12, 2023

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
Copy link
Author

@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?

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

No branches or pull requests

2 participants