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.

Sign up for GitHub

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

Jump to bottom

bumper README is misleading #4

Open
pixelzoom opened this issue Dec 26, 2019 · 9 comments
Open

bumper README is misleading #4

pixelzoom opened this issue Dec 26, 2019 · 9 comments
Assignees
@jonathanolson
Labels
priority:3-medium

Comments

@pixelzoom
Copy link
Contributor

pixelzoom commented Dec 26, 2019 •
edited
Loading

The README.md for bumper identifies it as "an educational simulation in HTML5, by PhET Interactive Simulations", and it has an incorrect screenshot.

I have no idea what this repo is for, but these problems would seem to be related to phetsims/tasks#1018 "Improve high level documentation about phetsims repos".
@pixelzoom
Copy link
Contributor Author

The sim actually looks like this, which appears to be the same as chains:

screenshot_38

@jonathanolson
Copy link
Contributor

The README.md for bumper identifies it as "an educational simulation in HTML5, by PhET Interactive Simulations", and it has an incorrect screenshot.

That is likely just the automatically generated readme for anything that looks like a simulation. The repo description on GitHub reads:

Safely-deployable sim for testing our build/deployment procedures.

Is there a recommended way to better document this? Do we need to change our README generation procedures?

@pixelzoom
Copy link
Contributor Author

pixelzoom commented Dec 31, 2019 •
edited
Loading

I don't know if we need to change any procedures. Just pointing out that bumper's README.md is a bit misleading/incorrect. So is chains, examples-sim,... chains also has the same bogus/bizarre screenshot as bumper, created by @jbphet.

chains-screenshot

Assigning to @ariel-phet to decide whether to do anything about this.

@pixelzoom pixelzoom assigned ariel-phet and unassigned pixelzoom Dec 31, 2019
@pixelzoom
Copy link
Contributor Author

pixelzoom commented Dec 31, 2019 •
edited
Loading

I asked @jbphet on Slack if there was any significance to the current screenshots for chains and bumper. He replied:

Nope. I suspect it was some quickie placeholder thing to get a screenshot in place, which would have been needed to support deployments.

I'd suggest creating an issue to update the screenshots and assigning it to @KatieWoe - she creates most of them these days.

@pixelzoom
Copy link
Contributor Author

pixelzoom commented Dec 31, 2019 •
edited
Loading

@KatieWoe could you please update the screenshots for chains and bumper? Then please leave this issue assigned to @ariel-phet so he can decided whether the README.md text needs to be changed.

@KatieWoe
Copy link
Contributor

KatieWoe commented Jan 2, 2020

How do these look?
bumper-screenshot
chains-screenshot

@pixelzoom
Copy link
Contributor Author

Those look great @KatieWoe, feel free to check them in to GitHub.

KatieWoe added a commit to phetsims/chains that referenced this issue Jan 3, 2020
@KatieWoe
for phetsims/bumper#4
61186a6
KatieWoe added a commit that referenced this issue Jan 3, 2020
@KatieWoe
for #4
bdb1ae9
@KatieWoe
Copy link
Contributor

KatieWoe commented Jan 3, 2020

above commits should do it.

@ariel-phet
Copy link

Yes, it would be good to change the README from the boiler plate

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jonathanolson jonathanolson

Labels
priority:3-medium
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@jonathanolson @pixelzoom @ariel-phet @KatieWoe