flesh out phet-software-design-patterns.md

[pixelzoom]

Related to phetsims/tasks#969 (comment)

At 1/3/19 dev meeting, @ariel-phet suggested that we should spend the next couple weeks of "core hours" reviewing PhET-specific design patterns. @zepumph suggested that someone should evaluate the state of phet-software-design-patterns.md, and @ariel-phet asked me to do that.

[pixelzoom]

phet-software-design-patterns.md is currently just a sketch of what might be covered in the document. With the exception of the the "options and config parameters" section, there's no meat.

Some options:
(1) Have someone make a pass at fleshing out the document (not something that I have time for or interest in doing), then discuss/refine in discussions.
(2) Discuss patterns one at a time, and assign someone to flesh out the documentation for that pattern based on the discussion. Probably the more expensive of the 2 approaches.

@ariel-phet How do you want to proceed for next Monday's "core hours" discussion, and longterm?

[ariel-phet]

@pixelzoom Lets do a compromise.

Can you flesh out 1 pattern? and then that can be discussed at core hours. Perhaps after that, we can do a round robin. Each week a developer takes on a pattern to flesh out, and then it gets discussed at core hours. Seems like it would be a good learning experience.

[pixelzoom]

That sounds OK, and I'll be happy to flesh out one of the patterns. But I won't get to it before next Monday's core hours.

[zepumph]

I'll take a stab at one for Monday if you would like.

[pixelzoom]

1/7/19 dev meeting on Zoom during core hours:

We put "interested developers" next to each pattern, developers self-identified who would benefit from having the pattern description fleshed out.

@pixelzoom will flesh out "Enumeration" for 1/14/19, for discussion at core hours.

@zepumph will flesh out "Dispose" for 1/14/19 (in case there's time to discuss), but we might not get to discuss until 1/28/19.

[pixelzoom]

@pixelzoom will flesh out "Enumeration" for 1/14/19, for discussion at core hours.

On hold until we resolve phetsims/phet-core#53 (Enumeration conventions).

[zepumph]

Dispose design pattern added above.

[pixelzoom]

Enumeration description has been fleshed out. Devs please review for Monday 1/14/19 discussion.

[zepumph]

Discussed dispose today. I will update the docs and we will review next week. I would like to note here that we discussed the 4 implementation patterns seen in the code, but we didn't discuss the general pattern or when it is appropriate to dispose (and conversely when we shouldn't be disposing/when there is no need).

I would like to make sure we do that before moving on from this pattern.

[pixelzoom]

All sections of phet-software-design-patterns.md have now been fleshed out. So closing this issue.