Skip to content
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

Document PhET software design patterns related to TypeScript. #170

Closed
pixelzoom opened this issue Nov 4, 2021 · 4 comments
Closed

Document PhET software design patterns related to TypeScript. #170

pixelzoom opened this issue Nov 4, 2021 · 4 comments
Assignees

Comments

@pixelzoom
Copy link
Contributor

TS is going to result in revisions to existing PhET design patterns (e.g. options, enumeration), and will likely result in some new patterns. These TS patterns should eventually be documented, as has been done for JS patterns in https://github.com/phetsims/phet-info/blob/master/doc/phet-software-design-patterns.md. It's unclear whether they should be documented in that same .md file, in a new .md file,... In any case, keep in mind that the JS patterns will be around for a while (maybe forever).

@samreid
Copy link
Member

samreid commented Nov 9, 2021

@chrisklus and I discussed the need for a "conventions" document, which is different than a "design patterns" document and possibly also different than the "code review" doc. I added a first draft from our collaboration above.

@zepumph
Copy link
Member

zepumph commented Nov 9, 2021

I think it would be worth noting phetsims/ratio-and-proportion#405, as most of these felt like "conventions" as opposed to patterns or syntax/code-style questions.

@samreid samreid self-assigned this Nov 10, 2021
samreid added a commit that referenced this issue Nov 10, 2021
@samreid
Copy link
Member

samreid commented Nov 10, 2021

samreid added a commit that referenced this issue Nov 10, 2021
@samreid samreid removed their assignment Nov 10, 2021
@samreid samreid self-assigned this Feb 25, 2022
samreid added a commit that referenced this issue Apr 23, 2022
samreid added a commit that referenced this issue Apr 23, 2022
@samreid
Copy link
Member

samreid commented Aug 4, 2022

We have improved and elaborated on our TypeScript documentation in other issues, closing.

@samreid samreid closed this as completed Aug 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants