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

Was the README.md generated by grunt published-README or grunt unpublished-README? #43

Closed
Tracked by #5
samreid opened this issue Aug 11, 2021 · 4 comments
Closed
Tracked by #5
Assignees

Comments

@samreid
Copy link
Member

samreid commented Aug 11, 2021

From #5, what should the README for density-buoyancy-common look like? It seems like https://github.com/phetsims/circuit-construction-kit-common/ has a generated one. The density-buoyancy-common one looks reasonable but doesn't match the code review document so I thought I'd mention it.

@jonathanolson
Copy link
Contributor

I usually consider this applying to sim repos. density-buoyancy-common isn't a sim repo (it won't get published on its own), so the CCK-common one looks... incorrect.

Thoughts? Should this be discussed at a dev meeting?

@samreid
Copy link
Member Author

samreid commented Aug 11, 2021

counting-common has unpublished-README. inverse-square-law-common has a custom README. number-line-common has a custom README. Hopefully we can decide this on slack, I'll reach out.

@samreid
Copy link
Member Author

samreid commented Sep 2, 2021

We agreed it is OK for common code repos to have custom README.md files. The density-buoyancy-common one looks good. Back to @samreid to update the code review checklist to indicate that is OK.

@samreid
Copy link
Member Author

samreid commented Sep 29, 2021

I noted this in the code review checklist. Closing.

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