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

Use Architecture Decision Records (ADR) #30

Open
mhellmeier opened this issue May 3, 2024 · 0 comments
Open

Use Architecture Decision Records (ADR) #30

mhellmeier opened this issue May 3, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation feature New feature or request

Comments

@mhellmeier
Copy link
Member

🚀 Feature Request

Current Problem

During the development of this project, different architectural decisions were made. For external people, it is hard to understand why different decisions are made and what the background is. Further, discussions can start in the future from aspects already discussed in the past.

Proposed Solution

To prevent duplicate discussions and be transparent, architecture decision records (ADRs) should be used. There should be an ADR template with a location where all ADRs are stored (like in a docs/adr folder). All ADRs should have the same structure and be easily accessible (in Markdown format).

Additional Context

Existing open source available examples or templates should be used.

@mhellmeier mhellmeier added documentation Improvements or additions to documentation feature New feature or request labels May 3, 2024
@mhellmeier mhellmeier self-assigned this May 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant