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

New sim checklist #2

Closed
24 tasks done
chrisklus opened this issue Feb 1, 2022 · 1 comment
Closed
24 tasks done

New sim checklist #2

chrisklus opened this issue Feb 1, 2022 · 1 comment
Assignees

Comments

@chrisklus
Copy link
Contributor

chrisklus commented Feb 1, 2022

New Repository Checklist

These steps contain the following placeholders that you'll need to fill in:

  • {{AUTHOR}}} - the name that will appear in @author code annotations, e.g. Jane Doe
  • {{REPO}} - the repository name, e.g. gas-properties. This should be composed of lower-case characters and dashes, and should have <=214 characters (see naming constraints in https://docs.npmjs.com/cli/v7/configuring-npm/package-json).
  • {{TITLE}} - the simulation's title, e.g. Gas Properties

Steps to create a new simulation repo

At https://github.com/phetsims:

  • Press the "New" button.
  • Set the Description field to "{{TITLE}}" is an educational simulation in HTML5, by PhET Interactive Simulations.
  • Set visibility to "Public".
  • DO NOT check the "Initialize this repository with a README" checkbox.
  • Leave "Add .gitignore" set to "None"
  • Leave "Add a license" set to "None".

In your working copy of perennial repo:

  • Run grunt create-sim --repo="{{REPO}}" --author="{{AUTHOR}}" --title="{{TITLE}}" to create the file structure and skeleton code for the sim.

In your working copy of the sim repo:

  • git init
  • git add * .gitignore
  • git commit -m "Initial commit"
  • git remote add origin https://github.com/phetsims/{{REPO}}.git
  • git push -u origin master

At https://github.com/phetsims/{{REPO}}:

  • Go to Settings => Collaborators and teams, then "Add teams". See team assignment.md for assignments by repo type.
  • Create a Sim Checklist issue using template sim_checklist.md. Use "{{TITLE}} Master Checklist" as the issue name. Assign to @ariel-phet.

In your working copy of perennial repo:

  • Add the new repo to perennial/data/active-repos. Commit and push. Then pull perennial-alias so these two checkouts stay in sync. If needed immediately, run cd perennial/ && grunt generate-data and commit and push to update data lists. Otherwise it is done every night as part of daily grunt work.

Other:

  • Navigate to https://bayes.colorado.edu/dev/phettest/ and click the "Refresh Perennial" button. If you do not know the password, please ask another developer.
  • Apply GitHub labels. See github-labels/README.md.
  • Apply branch protection rules. Use This script to do so.
  • Notify Slack channel dev-public that the repo has been created. E.g. "I just added a new repository, {{REPO}}. Please pull perennial and perennial-alias and run clone-missing-repos.sh at your convenience."
  • If using IDEA/Webstorm (pre-2018), add the git source root for the repository.
  • Follow any remaining "Implementation" tasks in the Master Checklist issue that you created above.
  • If applicable, add any needed dependencies to phetLibs in package.json. If you change package.json, run grunt update.
  • Add the sim to responsible_dev.json.
  • Add the sim to chipper/tsconfig/all/tsconfig.json
@chrisklus chrisklus self-assigned this Feb 1, 2022
chrisklus added a commit that referenced this issue Feb 1, 2022
samreid added a commit that referenced this issue Feb 1, 2022
samreid added a commit that referenced this issue Feb 1, 2022
@chrisklus
Copy link
Contributor Author

Sim setup is complete. Sprint development is continuing over in #6. Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant