docs: [OEP-67] TypeScript for static type checking #521
Conversation
| TypeScript | ||
| ========== |
There was a problem hiding this comment.
I switched these over to sections so :ref: would work
| ========== | ||
|
|
||
| Several variants of typed JavaScript have grown in community popularity | ||
| recently, with `TypeScript`_ as the most popular. edX believes adding |
There was a problem hiding this comment.
| recently, with `TypeScript`_ as the most popular. edX believes adding | |
| recently, with `TypeScript`_ as the most popular. The Open edX community believes adding |
But really, should this section be rewritten since you're adding an ADR about actually using TypeScript? It's ok to update an OEP, just the update should be recorded in the change history at the bottom
There was a problem hiding this comment.
Sorry, I thought this was the OEP file not an ADR file. I would make the suggested language change but keep the updated TypeScript recommendation in ADR 7.
| ******** | ||
|
|
||
| Frontend repositories within the Open edX project will be updated to support the use of TypeScript, without | ||
| requiring existing frontend JavaScript code be rewritten in TypeScript. |
There was a problem hiding this comment.
Reading this (the Decision & Consequence sections) I lack context as to why this decision has been made and what consequence it has (like, what's the benefit of using TypeScript). I know you link out to external resources but I think it could be beneficial to add a sentence or two to provide context without requiring reading through external resources as well.
There was a problem hiding this comment.
I added a quick summary of a couple benefits of typescript here https://github.com/openedx/open-edx-proposals/compare/3af815b84c789af807d4e42927938024557c669f..f71d62cd46797a78be384e73f6577913ea599014
Let me know if there's something you feel is still missing!
brian-smith-tcril
force-pushed
the
typescript
branch
from
70f3c0d to
3af815b
Compare
brian-smith-tcril
force-pushed
the
typescript
branch
from
3af815b to
f71d62c
Compare
brian-smith-tcril
changed the title
No description provided.