brettfiedler
commented
1 year ago Preliminary notes:
phet-info note audit
High level notes
- Checklists have interesting information re: process, but are not very useful for new contributors
- Should intern-info be folded into onboarding? Isn't an intern a new contributor?
- The information here is largely redudant to the onboarding doc. Check for helpful tips and add to a different document.
- The CLA is in the community repo, doesn't need to be here, possibly. OR, better yet, doesn't need to be in community.
- Doc folder contains most of the useful information
- Place Inclusive Features Quickstart guides into their own subdirectory
- These have nice information about using the common code libraries and exemplars for creating inclusive features, but the features themselves are not independent in all cases. They require our tooling (grunt, chipper, etc) to be used, and are not standalone. This is a good thing, but it means that they are not as useful to the community as they could be.
- ADD: A document with concise instructions for enabling or integrating inclusive features into a web interactive, using a sim as an exemplar if needed.
- The PhET Overview and Onboarding Documents are our primary documents here. We should change weave these together more concisely. Onboarding needs to stay PhET specific, but we can make a different version that is more community facing.
- WHAT NEEDS TO CHANGE ABOUT PhET OVERVIEW?
- WHAT CAN BE EXTRACTED FROM ONBOARDING?
Doc Site
- Oliver on Slack:
-
I wonder if continuing to make phet-info public is the right call… it seems to contain a lot of internal information. If there are things in that repo needed for POSE perhaps a bigger reorganization is needed? (Or a new repo)
-
- Could choose to keep helpful information in phet-info, and sync across to community docs with https://github.com/marketplace/actions/repo-file-sync-action
Detailed Tree:
(++): Has info that should definitely go to Community (+) : useful as a reference (%) : might be worth a small reference in limited cases, or has information worth extracting null : not useful (--) : not sure why this is here
- checklists:
some checklists provide good insight into sim dev process, but not- S2015R-checklist.md
- (%) code-review-checklist.md
- delete-repo-checklist.md
- employee-leaving-checklist.md
- external-library-checklist.md
- new-repo-checklist.md
- (%) new-student-worker-checklist.md
- postmortem-process.md
- rename-repo-checklist.md
- (%) sim-checklist.md
- updating-metadata.md
- youtube-upload-checklist.md
- conduct
- (--) communication-guidelines.md:
This is very internal and should be moved and/or hidden?
- (--) communication-guidelines.md:
- conferences
- README.md
- collect-emails.html:
This is an offline form for collecting emails at conferences. Should inquire as to need or if it should live somewhere else. special-ops?
- contributors
- (++) CLA.md:
I have question out regarding this for common code - (++) CU PhET Institutional Contributor License Agreement.pdf:
I think this is specifically for partnerships, where CU may need to be legally involved.
- (++) CLA.md:
- deployment-info
- README.md
- chipper-1.0.md:
helpful only for those doing old JavaScript development - (+) chipper-2.0.md:
This is specific tooling for simulation development. Very helpful if creating a PhET-like. I believe this will need to be greatly updated when Deno is introduced
- doc
- (+) accessible-preferences-quickstart-guide.md:
requires a preferences menu. Where does pref menu live? Sim-specific, but good practices contained - (+) alternative-input-quickstart-guide.md:
Good practices, sim-specific and requires our tooling - (+) coding-conventions.md:
not required for community, but good practices, worth linking - BROKEN LINK: best-practice-for-modules.md
- (--) devs-onboarding-pm-q4-2021.md:
This looks old and irrelevant - (+) dynamic-string-layout-quickstart.md:
Good practices, sim-specific and requires our tooling - (+) interactive-description-technical-guide.md:
Good practices, sim-specific and requires our tooling - (+) interactive-highlights-quickstart-guide.md:
Good practices, sim-specific and requires our tooling - (++) new-dev-onboarding.md:
Good information here, needs that info extracted as a different document. - (++) phet-dev-exercises.md:
Very helpful reference for those starting to use our libraries for SIM DEVELOPMENT - (++) phet-development-overview.md:
Key document for using PhET libraries. - (+) phet-software-design-patterns.md:
Very helpful reference for those starting to use our libraries for SIM DEVELOPMENT - (%) supported-browsers.md:
This is maybe worth a reference, but specific to our QA process - (++) typescript-conventions.md:
Key reference for using PhET libraries - (++) typescript-quick-start.md:
Key reference for using PhET libraries - (+) typescript-webstorm-file-watcher.md:
specific to webstorm, but useful for those using it
- (+) accessible-preferences-quickstart-guide.md:
- git-template-dir
- pre-commit.sh
- github-dashboard
- issueReport.js
- processCachedIssues.js
- github-labels
- README.md
- change-label.sh
- delete-label.sh
- (+) github-labels
- (+) labeling-scheme.md
- new-label-all-repos.sh
- new-repo-add-labels.sh
- printGithubAuthorization.js
- update-repos-list.js
- (%) ide:
this whole directory may be a nice reference, but is not necessary- idea
- performance.md
- phet-idea-codestyle.xml
- setup.md
- sublime-text
- phet-plugin
- files for a sublime package to add phet tasks to command pallete
- Monokai PhET.tmTheme
- PhETJavaScript.tmLanguage
- eslint-and-sublime-text.md
- vscode
- setup.md
- (%) intern-info:
most of the information here I think is redundant to info in onboarding and overview docs- git_bash_tips.md
- job-postings.md
- web-dev-intern-setup.md
- (%) issue-info:
most of this is related to PhET specific processes, but there should be strong overlap between the issue templates for all repos and this- github-issue-philosophy.md
- unfuddle-ticket-search.md
- useful_searches.md
- policies:
these are very PhET employee and policy internal. Not community facing.- Confidentiality-of-user-information.md
- availability.md
- team assignment.md
- project-management:
This is all outdated and also very interal. Not community facing.- common-code-issue-template.md
- management-granularity-levels.md
- reportEpicIssuesNotInSpreadsheet.js
- (--) qa-team-info:
This is redundant? I did not get a clear answer on Slack- Screenshots.md
- applicant-task.md
- resources
- (%) screen-reader
- (%) developer-resources.md
- sim-info
This is all very PhET specific. Not community facing.- README.md
- areAllReposInFile.js
- generateMarkdownOutput.mjs
- getAllRepos.js
- pixelzoom-sims.md
- printReposPerDev.mjs
- responsible_dev.json
- responsible_dev.md
- LICENSE
- README.md
- package.json
I'll place findings here from combing through the phet-info repository to identify information that is helpful to external users, separate PhET-employee information from dev agnostic information, and suggest changes to phet-info and/or community repos.