Skip to content

docs(adr): create decision record guide and template#6589

Open
g-husam wants to merge 13 commits into
mainfrom
docs/adr-template
Open

docs(adr): create decision record guide and template#6589
g-husam wants to merge 13 commits into
mainfrom
docs/adr-template

Conversation

@g-husam

@g-husam g-husam commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a new README file for decision records, detailing when and how to write them. The review feedback focuses on aligning the Markdown formatting with the Google Markdown Style Guide, specifically by wrapping lines to adhere to the 80-character limit, removing trailing whitespace, and using an explicit path for the internal template link.

Comment thread doc/decision-records/README.md
Comment thread doc/decision-records/README.md
Comment thread doc/decision-records/README.md
Comment thread doc/decision-records/README.md Outdated
@g-husam g-husam requested review from hj690 and noahdietz June 30, 2026 15:49
@g-husam g-husam marked this pull request as ready for review June 30, 2026 15:49
@g-husam g-husam requested a review from a team as a code owner June 30, 2026 15:49
@g-husam g-husam force-pushed the docs/adr-template branch from 098d935 to fd7cbc6 Compare June 30, 2026 15:52
1. Designing an API
1. Code generation implementation

When unsure, ask a friend, or err on the side of writing a quick one by using Gemini to help structure your thoughts and context using the template linked below.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Should we tell gemini about these files/dir and when to write/update one in GEMINI.md?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yeah we can tell it about it in GEMINI.md, to reference when appropriate, I'll add (tho historically Gemini is pretty poor at following those instructions IME lol). Maybe not to write one, as I'd leave it to the human to decide that since its usually the human knowing when to write one and driving that decision.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

actually I'm not sure when this context is really needed, as its more historical reference, so might be better to just leave it out and let developers add to context when deemed necessary, to avoid polluting it?

@hj690 hj690 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

💯

Comment on lines +11 to +15
What is the status, such as proposed, accepted, rejected, deprecated, superseded, etc.?

* 2025-06-25: Proposed
* 2025-07-01: Accepted
* 2025-12-15: Superseded

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I kind of wish we just had Current and Superseded - I feel like we shouldn't submit the PR in Proposed state bc its not clear if its authoritative or not ("well it was checked in, but its not approved so...?"), and when we'd update it to Accepted or remove it altogether.

Basically I feel like any PR introducing a new one is effectively the Proposed state, and if it is checked in it is at first Current, until it is deprecated/superseded, at which point it is Superseded.

Thoughts?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yeah good point, it should be in one of the (semi) terminal states, like accepted, rejected (still very valuable!!), superseded, etc.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

although I guess proposed captures when it was first created/started discussion

g-husam added 12 commits July 1, 2026 01:06
Signed-off-by: g-husam <husameldawi@google.com>
Signed-off-by: g-husam <husameldawi@google.com>
Signed-off-by: g-husam <husameldawi@google.com>
Signed-off-by: g-husam <husameldawi@google.com>
Signed-off-by: g-husam <husameldawi@google.com>
Signed-off-by: g-husam <husameldawi@google.com>
Signed-off-by: g-husam <husameldawi@google.com>
Signed-off-by: g-husam <husameldawi@google.com>
Signed-off-by: g-husam <husameldawi@google.com>
Signed-off-by: g-husam <husameldawi@google.com>
…n-record-template.md

Signed-off-by: g-husam <husameldawi@google.com>
Signed-off-by: g-husam <husameldawi@google.com>
@g-husam g-husam force-pushed the docs/adr-template branch from 2f9fcc8 to 1bc3669 Compare July 1, 2026 05:06
Signed-off-by: g-husam <husameldawi@google.com>
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

Successfully merging this pull request may close these issues.

4 participants