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

implementation-notes.md #151

Closed
pixelzoom opened this issue Aug 3, 2020 · 3 comments
Closed

implementation-notes.md #151

pixelzoom opened this issue Aug 3, 2020 · 3 comments
Assignees

Comments

@pixelzoom
Copy link
Contributor

pixelzoom commented Aug 3, 2020

Write the implementation overview in
https://github.com/phetsims/natural-selection/blob/master/doc/implementation-notes.md.

pixelzoom added a commit that referenced this issue Aug 12, 2020
@pixelzoom pixelzoom self-assigned this Aug 12, 2020
@pixelzoom
Copy link
Contributor Author

pixelzoom commented Aug 20, 2020

Done, closing.

I tried something new in these notes. For model and view, I provided bullet lists of things that you might want to find out more about, and pointers to the relevant code. For example:

Here are pointers to some of the major features of the model:

We'll see if devs find this useful during code review.

@pixelzoom
Copy link
Contributor Author

Reopening for @jonathanolson's feedback in #203 (code review).

@pixelzoom
Copy link
Contributor Author

pixelzoom commented Sep 16, 2020

Over in #203 (comment), @jonathanolson said:

Does implementation-notes.md adequately describe the implementation, with an overview that will be useful to future maintainers? Please provide feedback in #203.

Incredibly useful and perfect! Didn't see any changes to recommend. Thanks!

I meant to say "provide feedback in #151", not #203. But I'm glad it was useful, and I'm going to close this issue.

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

2 participants