chore(documentation): decision records on Python directory structure and views management #51
Conversation
google-cla
bot
added
the
cla: yes
There was a problem hiding this comment.
Thanks for writing up decisions records on some of our non-obvious Python practices!
I've left the same feedback on both. My higher-level point to clarify is the importance of the decision record is not the "what". What is probably better answered in an architecture doc.
The decision records are here to help us understand the "why", and the terms under which we might reverse or evolve that decision. I think of it as something like a contract the team is making with the software: here's how things can exist as long as these terms are true.
| @@ -10,6 +10,41 @@ Decision records should attempt to follow the Y-statement format for consistency | |||
| In the context of **<use case/user story u>**, facing **<concern c>** we decided for **<option o>** and neglected <other options>, to achieve <system qualities/desired consequences>, accepting <downside d/undesired consequences>, because <additional rationale>. | |||
| ``` | |||
|
|
|||
| ## Decision: Use a two-folder-level split for Jinja templates | |||
|
|
|||
| In order to organize our Jinja HTML templates, we decided to **use a two-level folder level split**. This will be combined with Jinja inheritance (i.e. the `extends` clause) for common components where possible. | |||
There was a problem hiding this comment.
Could you clarify the benefit and the trade-off?
There was a problem hiding this comment.
Added revision criteria - PTAL?
docs/decisions.md
Outdated
|
|
||
| ## Decision: Use a one-folder-level split for Flask view functions | ||
|
|
||
| In order to organize our Flask view functions, we decided to **use a single folder level split combined with Flask blueprints**, accepting that this may be subject to revision in the future. |
There was a problem hiding this comment.
All decisions are subject to revision. Could you clarify the benefit/trade-off, or putting it another way, the circumstances under which this might be changed?
There was a problem hiding this comment.
Added revision criteria - PTAL?
grayside
changed the title
Decisions related to #37
@engelke @dinagraves FYI