villebro commented on pull request #17919: URL: https://github.com/apache/superset/pull/17919#issuecomment-1008769438
> We have a lot of scripts in `package.json` and not all are easily understandable by just looking at their name. I was researching how people document these things and found out that [some](https://dev.to/napolux/how-to-add-comments-to-packagejson-5doi) add special comments to it and others maintain a separate file with the documentation. I wonder if we should add a script called `help` that prints the docs for the other scripts. What do you think? Of course, this would be a separate PR. @michael-s-molina That's probably a good idea and would improve the developer experience - I've found the `scripts` prop to tend to grow uncontrollably over time in projects, often with many "private" scripts that aren't really meant to be run by from the cli. I wonder if we could at least start by adding an underscore to the scripts that are only meant to be run from other scripts to remove some mental overhead? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
