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

todo-should-have-issue should not hard code opt-in and opt-out list #1372

Closed
6 of 65 tasks
zepumph opened this issue Jan 16, 2023 · 5 comments
Closed
6 of 65 tasks

todo-should-have-issue should not hard code opt-in and opt-out list #1372

zepumph opened this issue Jan 16, 2023 · 5 comments

Comments

@zepumph
Copy link
Member

zepumph commented Jan 16, 2023

This was causing problems over in the number suite repos, and my best guess is because of caching. It would be good to make this more idiomatic anyways. Where you can turn it on and off for each repo. When I run on every single repo except scenery, kite, dot, and simula-rasa, here is the list. In general, there are obvious repos where we should turn things off, but many repos just have one or two TODOs, we could easily promote those to issues or just find the original committing issue. To be clear. I am NOT making this a chip away issue, but I will use this list myself. Note that I will, in most cases, just continue opting out in each package, which is nice and clear, and will allow more repos to opt into this in the future, easier.

@zepumph
Copy link
Member Author

zepumph commented Jan 16, 2023

In general, the two types of repos that I'm opting out of for having todos link issues are:

  1. Very old and quite gross, and with quite a few TODOs
  2. In active development, and it makes sense to not make this requirement since documentation would stifle productivity.

zepumph added a commit to phetsims/perennial that referenced this issue Jan 16, 2023
zepumph added a commit to phetsims/acid-base-solutions that referenced this issue Jan 16, 2023
zepumph added a commit to phetsims/circuit-construction-kit-black-box-study that referenced this issue Jan 16, 2023
zepumph added a commit to phetsims/charges-and-fields that referenced this issue Jan 16, 2023
zepumph added a commit to phetsims/balancing-chemical-equations that referenced this issue Jan 16, 2023
zepumph added a commit to phetsims/circuit-construction-kit-common that referenced this issue Jan 16, 2023
zepumph added a commit to phetsims/area-model-common that referenced this issue Jan 16, 2023
zepumph added a commit to phetsims/center-and-variability that referenced this issue Jan 16, 2023
zepumph added a commit to phetsims/capacitor-lab-basics that referenced this issue Jan 16, 2023
zepumph added a commit to phetsims/eating-exercise-and-energy that referenced this issue Jan 16, 2023
zepumph added a commit to phetsims/density-buoyancy-common that referenced this issue Jan 16, 2023
zepumph added a commit to phetsims/wave-on-a-string that referenced this issue Jan 16, 2023
zepumph added a commit to phetsims/plinko-probability that referenced this issue Jan 16, 2023
zepumph added a commit to phetsims/xray-diffraction that referenced this issue Jan 16, 2023
zepumph added a commit to phetsims/gravity-and-orbits that referenced this issue Jan 16, 2023
zepumph added a commit to phetsims/fraction-comparison that referenced this issue Jan 16, 2023
zepumph added a commit to phetsims/fluid-pressure-and-flow that referenced this issue Jan 16, 2023
zepumph added a commit to phetsims/greenhouse-effect that referenced this issue Jan 16, 2023
@zepumph
Copy link
Member Author

zepumph commented Jan 16, 2023

Ok. I updated repos that had many TODOs to opt out, and I had repos with just one or two issues link to an issue likely linked above. This work felt very helpful to me. Many more repos than we originally supported were already following this, so it is nice to automatically include those in linting. I also feel like the rule got much simpler. @pixelzoom would you like to review this in correlation to phetsims/number-suite-common#30?

@zepumph
Copy link
Member Author

zepumph commented Jan 17, 2023

@KatieWoe reported that aqua was failing lint on CT because I forgot that CT doesn't pull aqua, so I manually went on there to pull it.

@pixelzoom
Copy link
Contributor

... . @pixelzoom would you like to review this in correlation to phetsims/number-suite-common#30?

Looks good.

It took me quite awhile to figure out how simula-rasa was opting out. Instead of opting out in package.json, todo-should-have-issue.js is explicitly ignoring simula-rasa source files. In the above commit, I improved the doc for this, so it makes sense to someone who may not be familiar with simula-rasa.

For repos where I'm responsible dev, I also inspected (and in some cases addressed) the TODOs that were modified by @zepumph's commits.

Back to @zepumph in case there's anything else to do here.

@pixelzoom pixelzoom assigned zepumph and unassigned pixelzoom Jan 17, 2023
@zepumph
Copy link
Member Author

zepumph commented Jan 18, 2023

Yes cd8e539 is exactly right. Thanks for the update and sorry it was so hidden. Also aqua linting is passing now. 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