geido commented on issue #35822:
URL: https://github.com/apache/superset/issues/35822#issuecomment-3442822925
Great initiative!
> Embed in code comments
> Pollutes codebase. Difficult to maintain consistency. Doesn't help with
architectural/workflow context.
While I tend to agree with this, I still think context should live as close
as possible to where it pertains. Architectural/workflow context can live in a
dedicated `context/ `directory that serves as the foundation, but then we might
have component / code-specific context to live as close as possible to the
code, as we do for _storybook_ or test files:
```
Component/
-- index.tsx
--{Component}.stories.tsx
--{Component}.test.tsx
--{Component}.context.md
```
We could apply the same approach to the backend, commands, DAOs, and so on.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
