-
Notifications
You must be signed in to change notification settings - Fork 11
Decision records shall have a date #230
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
Conversation
Since they reflect decisions made at a specific time, it is often very informative when that happened.
|
The created documentation from the pull request is available at: docu-html |
masc2023
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will be discussed in the next community meeting
| :id: dec_rec__<Platform|Feature|Component>__<Title> | ||
| :status: <proposed|accepted|deprecated|rejected|superseded> | ||
| :affects: <link> | ||
| :date: <YYYY-MM-DD> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Compare here, date is part of commit history e.g. https://github.com/eclipse-score/score/commits/main/docs/design_decisions/DR-003-infra.md, if there is a way to put it in automatically, fine for me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Git history tells you when a file is modified that might be more recent than the last status change. For example, consider a mere layout change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For reference, DR-004 just got merged. In contrast to 001 to 003, it is much closer to the process-provided template. I put the date into the content there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am against this documentation of information that we already get provided by version management. If it is about a status change (which is documented in one line) you can find out via git blame. If we do this in this kind of documentation, this would in my opinion invalidate our argumentation that for documents we do not need to document author, reviewer, version, date because this all is in github already available. If you want to automatize this setting of the date, I would be fine, but is it really worth the effort?
aschemmel-tech
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do not support this
| :id: dec_rec__<Platform|Feature|Component>__<Title> | ||
| :status: <proposed|accepted|deprecated|rejected|superseded> | ||
| :affects: <link> | ||
| :date: <YYYY-MM-DD> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am against this documentation of information that we already get provided by version management. If it is about a status change (which is documented in one line) you can find out via git blame. If we do this in this kind of documentation, this would in my opinion invalidate our argumentation that for documents we do not need to document author, reviewer, version, date because this all is in github already available. If you want to automatize this setting of the date, I would be fine, but is it really worth the effort?
|
@a-zw , Process Community do not agree to add this new attribute, any change can be seen in the commit history (including date, status and which code changed), otherwise we would also need to discuss, why it is only for DR documents and not for all others. |
Since they reflect decisions made at a specific time, it is often very informative when that happened.