auto format all md in phet-info, #215

phetsims · Aug 21, 2023 · cdbc14d · cdbc14d
1 parent 465d4fb
commit cdbc14d
Show file tree

Hide file tree

Showing 47 changed files with 1,213 additions and 785 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,15 @@
 phet-info
 =========
 
-Welcome! This is a collection of information shared by PhET team members for the purpose of using GitHub effectively and for other process-related topics. If you're new to PhET Sims and would like to learn more about how we develop our resources, we recommend these two to get started:
-+ [Development Overview](https://github.com/phetsims/phet-info/blob/main/doc/phet-development-overview.md): General information on how to build and edit sims locally, as well as other content of interest.
-+ [Onboarding Documentation](https://github.com/phetsims/phet-info/blob/main/doc/new-dev-onboarding.md): This one is for new developers at PhET, to help them in their journey. However, any developer might find useful information as well, such as environment set up, or roadmaps to gain familiarity with our codebase.
+Welcome! This is a collection of information shared by PhET team members for the purpose of using GitHub effectively and
+for other process-related topics. If you're new to PhET Sims and would like to learn more about how we develop our
+resources, we recommend these two to get started:
 
++ [Development Overview](https://github.com/phetsims/phet-info/blob/main/doc/phet-development-overview.md): General
+  information on how to build and edit sims locally, as well as other content of interest.
++ [Onboarding Documentation](https://github.com/phetsims/phet-info/blob/main/doc/new-dev-onboarding.md): This one is for
+  new developers at PhET, to help them in their journey. However, any developer might find useful information as well,
+  such as environment set up, or roadmaps to gain familiarity with our codebase.
 
-To see a list of responsible developers based on each repo, see [here](https://github.com/phetsims/phet-info/blob/main/sim-info/responsible_dev.md).
+To see a list of responsible developers based on each repo,
+see [here](https://github.com/phetsims/phet-info/blob/main/sim-info/responsible_dev.md).
diff --git a/checklists/S2015R-checklist.md b/checklists/S2015R-checklist.md
@@ -1,6 +1,7 @@
 Checklist for S2015R milestone (GitHub issues labeled "Summer 2015 redeploy")
 
 **Developer**
+
 - [ ] Review outstanding issues, mark what will be addressed for redeploy (@ariel-phet and original developer). Then
   mark these issues with a milestone.
 - [ ] Look over the code review checklist, decide if code review should be
@@ -13,6 +14,7 @@ Checklist for S2015R milestone (GitHub issues labeled "Summer 2015 redeploy")
 - [ ] Address RC issues
 
 **QA**
+
 - [ ] stringTest=double
 - [ ] stringTest=long
 - [ ] stringTest=X (short strings)
@@ -21,9 +23,10 @@ Checklist for S2015R milestone (GitHub issues labeled "Summer 2015 redeploy")
 - [ ] showPointerAreas (touchArea=red, mouseArea=blue)
 - [ ] Full screen test
 - [ ] Perform RC testing
- - [ ] Reference issues to RC test task
+- [ ] Reference issues to RC test task
 
 **Design/Admin**
+
 - [ ] Rosetta test (Opening sim to trusted translators for beta)
 - [ ] Check teacher tips are up to date
 - [ ] Check sim primer is up to date
diff --git a/checklists/delete-repo-checklist.md b/checklists/delete-repo-checklist.md
@@ -1,7 +1,9 @@
 # Delete/Archive Repo Checklist
 
 ## Before using this checklist:
+
 Decide whether the repo is being (a) deleted (b) archived or (c) removed from active-repos.
+
 - A repo should be deleted if
   * it is clutter
   * it will never be used again
@@ -15,19 +17,23 @@ Decide whether the repo is being (a) deleted (b) archived or (c) removed from ac
   * We cannot maintain it at the moment, but we expect to bring it back into maintenance in the future.
 
 ## Do not remove repos that:
+
 - Are listed as dependencies of any published simulation.
 - Would prevent checking out old versions of sims (do not mess with the bisection).
 - Contain otherwise useful information that is linked to
 
 ## Deleting or Archiving Steps
+
 - [ ] Before deleting something, it should be approved for deletion at a dev meeting
 - [ ] If not confident about some of the above questions/advice, bring it to a dev meeting
 - [ ] Create a delete/archive repo github issue in special-ops.
 - [ ] Inform the dev team to delete their local copy (perhaps put a checklist of developers in the github issue)
 - [ ] If issues crop up they should be documented in the associated github issue for the dev responsible for deletion
-- [ ] The repo should be removed from active-repos, ideally a few minutes before archiving/deleting (so automated processes do not try to pull it)
+- [ ] The repo should be removed from active-repos, ideally a few minutes before archiving/deleting (so automated
+  processes do not try to pull it)
 - [ ] In general, removing the repo should not break much, if empty rows in CT are a concern,restart CT
 - [ ] If archiving, update the repo's README.md file to indicate why it is archived
 - [ ] Remove from chipper/tsconfig/all/tsconfig.json (if present)
 
-We should explicitly state whether something needs to be done to delete the directory from aqua, build-server, and phettest, or whether these directories get automatically deleted, or just hang around forever with no consequences
+We should explicitly state whether something needs to be done to delete the directory from aqua, build-server, and
+phettest, or whether these directories get automatically deleted, or just hang around forever with no consequences
diff --git a/checklists/employee-leaving-checklist.md b/checklists/employee-leaving-checklist.md
@@ -1,17 +1,19 @@
 # Employee/Affiliate Leaving Checklist
 
 ## Responsibilities of Departing Employee
+
 - [ ] Submit your letter of resignation to supervisor.
 - [ ] Ensure your address is up to date in myCUinfo. This ensures you will receive your W-2 in a timely manner.
 - [ ] Inform committees/team you are working on of your resignation.
 - [ ] Submit final my.leave timesheet as soon as possible (once your last day is finalized)
 
 ### Turn in all university property to Physics department or PhET:
+
 - [ ] Door Keys. If needed, can be mailed to:
-Facilities Management Access Services
-University of Colorado Boulder
-UCB 53
-Boulder, CO 80309
+  Facilities Management Access Services
+  University of Colorado Boulder
+  UCB 53
+  Boulder, CO 80309
 - [ ] Buff OneCard and Eco Pass
 - [ ] A-Card or US Bank Cards
 - [ ] Library materials
@@ -20,19 +22,25 @@ Boulder, CO 80309
 - [ ] Parking permits and gate cards
 
 ### Files and access:
+
 - [ ] Pass on any necessary external account administration/credential information.
 - [ ] Ensure PhET digital files are stored in 'PhET Files'.
 
 ## Internal (PhET) Administrative Responsibilities
+
 - [ ] Exit Interview if appropriate
-- [ ] Buff One card, Eco-Pass returned via campus mail to 159 UCB or in person at the Campus Card Office located at Center for Community (C4C), Room N180, 159 UCB
+- [ ] Buff One card, Eco-Pass returned via campus mail to 159 UCB or in person at the Campus Card Office located at
+  Center for Community (C4C), Room N180, 159 UCB
 - [ ] Send copy of final leave balance sheet to HR 565UCB
 - [ ] (if applicable) Cancel PSC cards (procurement/travel card)
 - [ ] Final payment submitted
-- [ ] Pay up to max of vacation at separation, VCT  for resignation. Prorated leave accruals until last day worked and pay out vacation. 'CUES_HCM_LEAVE_ACCRUAL_SUM' - Leave Accrual Summary, departing employee signs, attached to VCT transaction.
+- [ ] Pay up to max of vacation at separation, VCT for resignation. Prorated leave accruals until last day worked and
+  pay out vacation. 'CUES_HCM_LEAVE_ACCRUAL_SUM' - Leave Accrual Summary, departing employee signs, attached to VCT
+  transaction.
 - [ ] Termination in HCM. Termination effective date in HCM is the following day after last day worked.
 
 ### Accounts
+
 - [ ] Remove from PhET google group
 - [ ] Remove from PhET Sharepoint Employee and Affiliate Group
 - [ ] Remove GitHub access

diff --git a/checklists/external-library-checklist.md b/checklists/external-library-checklist.md
@@ -5,8 +5,10 @@ PhET External Library Acceptance Checklist
 
 - [ ] It should have a compatible license, such as MIT
 - [ ] It should not be too large!
-- [ ] Is it something that we could have easily written ourselves?  If we could easily write it ourselves, then sometimes it is best to avoid the licensing encumbrances.
-- [ ] Does it use eval or new Function or Function(‘’,...)?  These are prohibited by the Chrome web store and not a good sign.
+- [ ] Is it something that we could have easily written ourselves? If we could easily write it ourselves, then sometimes
+  it is best to avoid the licensing encumbrances.
+- [ ] Does it use eval or new Function or Function(‘’,...)? These are prohibited by the Chrome web store and not a good
+  sign.
 - [ ] Is it popular enough that it has a high probability of being maintained for a good healthy lifetime?
 
 
diff --git a/checklists/new-repo-checklist.md b/checklists/new-repo-checklist.md
@@ -3,31 +3,39 @@
 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).
+- `{{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.
 - [ ] In "Repository' text field, enter the repository name.
-- [ ] In the Description field, enter `"{{TITLE}}" is an educational simulation in HTML5, by PhET Interactive Simulations.`
+- [ ] In the Description field,
+  enter `"{{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.
 - [ ] Do not check "Add .gitignore".
 - [ ] Do not check "Add a license".
 
 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.
+
+- [ ] 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 main`
 
 At https://github.com/phetsims/{{REPO}}:
+
 - [ ] Go to _Settings => Collaborators and teams_. Press the "Add teams" button.
   See [team assignment.md](https://github.com/phetsims/phet-info/blob/main/policies/team%20assignment.md) for
   assignments by repo type.
@@ -36,30 +44,45 @@ At https://github.com/phetsims/{{REPO}}:
   {{TITLE}} Main 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.  _Note that your sim won't run in phetmarks until this is done._
+
+- [ ] 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.  _Note that your sim won't run in
+  phetmarks until this is done._
 
 Other:
-- [ ] Navigate to https://bayes.colorado.edu/dev/phettest/ and click the "Refresh perennial, perennial-alias, and chipper" button. If you do not know the password, please ask another developer.
-- [ ] Apply GitHub labels. See [github-labels/README.md](https://github.com/phetsims/phet-info/blob/main/github-labels/README.md).
-- [ ] Apply branch protection rules using [protect-branches-for-repo.js](https://github.com/phetsims/perennial/blob/main/js/scripts/protect-branches-for-repo.js). Follow the instructions in the documentation at the top of the script.
-- [ ] 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."
+
+- [ ] Navigate to https://bayes.colorado.edu/dev/phettest/ and click the "Refresh perennial, perennial-alias, and
+  chipper" button. If you do not know the password, please ask another developer.
+- [ ] Apply GitHub labels.
+  See [github-labels/README.md](https://github.com/phetsims/phet-info/blob/main/github-labels/README.md).
+- [ ] Apply branch protection rules
+  using [protect-branches-for-repo.js](https://github.com/phetsims/perennial/blob/main/js/scripts/protect-branches-for-repo.js).
+  Follow the instructions in the documentation at the top of the script.
+- [ ] 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 Main 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](https://github.com/phetsims/phet-info/blob/main/sim-info/responsible_dev.json).
+- [ ] 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](https://github.com/phetsims/phet-info/blob/main/sim-info/responsible_dev.json).
 - [ ] Add the sim to chipper/tsconfig/all/tsconfig.json
-- [ ] If applicable, add corresponding dependencies from `phetLibs` in package.json to "references" in tsconfig.json. 
+- [ ] If applicable, add corresponding dependencies from `phetLibs` in package.json to "references" in tsconfig.json.
 
 ## Steps to create a different type of repo
 
 At https://github.com/phetsims:
+
 - [ ] Press the "New" button.
 - [ ] Fill in the Description field.  (Ask other developers if you need suggestions.)
 - [ ] Decide on visibility. (Ask other developers if you're not sure.)
 - [ ] Typically do not select options that would initialize the repo by creating files (README, .gitignore, LICENSE).
 
 In your working copy of the sim repo:
-- [ ] Create the file structure locally. It's best to start (currently) by copying from a similar repository (but without the `.git` directory). Make sure to keep `.gitignore`, etc.
+
+- [ ] Create the file structure locally. It's best to start (currently) by copying from a similar repository (but
+  without the `.git` directory). Make sure to keep `.gitignore`, etc.
 - [ ] `git init`
 - [ ] `git add * .gitignore`
 - [ ] `git commit -m "Initial commit"`
@@ -68,19 +91,31 @@ In your working copy of the sim repo:
 - [ ] `git push -u origin main`
 
 At https://github.com/phetsims/{{REPO}}:
-- [ ]Go to _Settings => Collaborators and teams_. Press the "Add teams" button. See [team assignment.md](https://github.com/phetsims/phet-info/blob/main/policies/team%20assignment.md) for assignments by repo type.
+- [ ]Go to _Settings => Collaborators and teams_. Press the "Add teams" button.
+See [team assignment.md](https://github.com/phetsims/phet-info/blob/main/policies/team%20assignment.md) for assignments
+by repo type.
 
 In your working copy of perennial repo:
-- [ ] If applicable: Add the new repo to `perennial/data/active-repos`. Commit and push. Pull perennial-alias. 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.
+
+- [ ] If applicable: Add the new repo to `perennial/data/active-repos`. Commit and push. Pull perennial-alias. 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.
 
 If this repo is a common code dependency for all sims:
-- [ ] Add it to the list of `clone` commands in [phet-development-overview.md](https://github.com/phetsims/phet-info/blob/main/doc/phet-development-overview.md)
+
+- [ ] Add it to the list of `clone` commands
+  in [phet-development-overview.md](https://github.com/phetsims/phet-info/blob/main/doc/phet-development-overview.md)
 - [ ] Update all sim published README files (because the "Quick Start" section has these git clone commands too).
 
 Other:
-- [ ] 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."
-- [ ] Apply GitHub labels. See [github-labels/README.md](https://github.com/phetsims/phet-info/blob/main/github-labels/README.md).
-- [ ] Apply branch protection rules. Use [this script to do so](https://github.com/phetsims/perennial/blob/main/js/scripts/protect-branches-for-repo.js).
+
+- [ ] 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."
+- [ ] Apply GitHub labels.
+  See [github-labels/README.md](https://github.com/phetsims/phet-info/blob/main/github-labels/README.md).
+- [ ] Apply branch protection rules.
+  Use [this script to do so](https://github.com/phetsims/perennial/blob/main/js/scripts/protect-branches-for-repo.js).
 - [ ] If using IDEA/Webstorm (pre-2018), add the git source root for the repository.
-- [ ] Add the repo to [responsible_dev.json](https://github.com/phetsims/phet-info/blob/main/sim-info/responsible_dev.json).
+- [ ] Add the repo
+  to [responsible_dev.json](https://github.com/phetsims/phet-info/blob/main/sim-info/responsible_dev.json).
 - [ ] Add the repo to chipper/tsconfig/all/tsconfig.json
diff --git a/checklists/new-student-worker-checklist.md b/checklists/new-student-worker-checklist.md
@@ -1,25 +1,29 @@
 # New Student Worker Checklist
 
 ## Admin
-- [ ] Complete Payroll forms (Personal data and Emergency contact), email to [email protected] [New Student Employee] (https://docs.google.com/document/d/1At37GOZ83luHGKOOQzjnJH2gu1E-sb-91OsdAmjYIIs/edit)
-- [ ] Enter/update W4 and Direct Deposit [New Student Employee] (https://docs.google.com/document/d/1At37GOZ83luHGKOOQzjnJH2gu1E-sb-91OsdAmjYIIs/edit)
-- [ ] Add contact info to [PhET Planning doc](https://docs.google.com/document/d/1hONYWo1R8gf24gaAd-5B1xmD_UrwbOG6BfB01WvrfiQ/edit)
+
+- [ ] Complete Payroll forms (Personal data and Emergency contact), email to
+  [email protected] [New Student Employee] (https://docs.google.com/document/d/1At37GOZ83luHGKOOQzjnJH2gu1E-sb-91OsdAmjYIIs/edit)
+- [ ] Enter/update W4 and Direct
+  Deposit [New Student Employee] (https://docs.google.com/document/d/1At37GOZ83luHGKOOQzjnJH2gu1E-sb-91OsdAmjYIIs/edit)
+- [ ] Add contact info
+  to [PhET Planning doc](https://docs.google.com/document/d/1hONYWo1R8gf24gaAd-5B1xmD_UrwbOG6BfB01WvrfiQ/edit)
 - [ ] Keys/card access if needed
 - [ ] Peripherals/computer if needed
 - [ ] Notify group, introduce (status meeting)
 
-
 ## Accounts
+
 - [ ] PhET gmail account (name.phet@gmail recommended)
- - [ ] Add to google group
- - [ ] Add to student employment calendar
+- [ ] Add to google group
+- [ ] Add to student employment calendar
 - [ ] Create github account
- - [ ] Github picture
- - [ ] Add to appropriate github team
- - [ ] Access to appropriate repos
+- [ ] Github picture
+- [ ] Add to appropriate github team
+- [ ] Access to appropriate repos
 - [ ] Unfuddle account
 - [ ] Subscribe to [email protected]
 - [(Instructions)](http://www.colorado.edu/oit/tutorial/email-list-manager-subscribe-list)
 - [ ] [Register](https://phet.colorado.edu/en/register?dest=%2F) for PhET website account
- - [ ] Grant admin access on website
- - [ ] Input job title (for About>People page)
+- [ ] Grant admin access on website
+- [ ] Input job title (for About>People page)