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

Introduce Architecture Decisions Records #13019

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

Conversation

marcusburghardt
Copy link
Member

@marcusburghardt marcusburghardt commented Feb 11, 2025

Description:

This PR introduces an Architecture Decisions Records in the project.
The intention is to make it easier to track architectural decisions along the time and to ensure more assertive decisions by introducing a simple and effective process.

This does not affect the communication we already have in Issues, PRs, Discussions, Gitter, Meetings or wherever.
But brings more transparency and reasoning regarding architecture decisions in the project.

Rationale:

For a better collaboration, documentation and transparency.

Review Hints:

Please, also take a look in the reference documents in 0000_architecture_decisions_records for a better context of this proposal.

@marcusburghardt marcusburghardt added Infrastructure Our content build system Documentation Update in project documentation. Highlight This PR/Issue should make it to the featured changelog. governance Issues or pull requests that relate to changes in the projects governance. labels Feb 11, 2025
@marcusburghardt marcusburghardt requested review from a team February 11, 2025 09:37
@marcusburghardt marcusburghardt added this to the 0.1.77 milestone Feb 11, 2025
@Mab879 Mab879 self-assigned this Feb 11, 2025
Copy link
Member

@Mab879 Mab879 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is my first round of feedback to the discussion started.

docs/adr/0000-architecture-decisions-records Outdated Show resolved Hide resolved
docs/manual/developer/01_introduction.md Show resolved Hide resolved
docs/adr/0000-architecture-decisions-records Outdated Show resolved Hide resolved
docs/adr/0000-architecture-decisions-records Outdated Show resolved Hide resolved
For a better collaboration and documentation.

Signed-off-by: Marcus Burghardt <maburgha@redhat.com>
The "-" in file name was also replaced by "_" to better align with other
documentation files.

Signed-off-by: Marcus Burghardt <maburgha@redhat.com>
Signed-off-by: Marcus Burghardt <maburgha@redhat.com>
Copy link
Contributor

@dodys dodys left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

overall the description looks good to me and looking forward to more on this topic

Signed-off-by: Marcus Burghardt <maburgha@redhat.com>
Copy link

codeclimate bot commented Feb 14, 2025

Code Climate has analyzed commit d4d093b and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 61.9% (0.0% change).

View more on Code Climate.

Copy link
Member

@Mab879 Mab879 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @marcusburghardt for working through my comments.

LGTM.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Update in project documentation. governance Issues or pull requests that relate to changes in the projects governance. Highlight This PR/Issue should make it to the featured changelog. Infrastructure Our content build system
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants