We need more information on issues reported

[ElonVolo]

Looking over a number of the issues that have been reported in the last several months, one of the things that would help the issues get resolved faster is if there was more information that could be used to rule out certain problems, issues, pre-conditions, etc.

The ideal bug report for jscodeshift, IMHO, contains

1. A list of the relevant specs of the project/dev environment setup (we could automate getting all this info to make it not a PITA)

• Platform, os version
• node.js version
• npm.js
• jscodeshift version

2. The command line command that is used to run the transform (if not done programmatically)
3. The complete content that is attempted to be transformed
4. The transform code
5. The expected result
6. The actual transformed content (or the error messages if the transformation wasn't successful)
7. If the bug relates to something involving transformations for a specific framework (I'm looking at you, mui, ;) ) there is a link to the person's project that uses the framework with all the relevant transforms already set up so a jscodeshift maintain can simply clone their repo and run the script
8. A link to a temporarily-created git repo that reproduces the issue using the smallest amount of code possible.
9. A link to an ast-explorer instance that sets up the transform (if relevant)

I thought there was already some documentation in the README.md. CONTRIBUTING.md, etc that went over all of this, but I'm not finding it (maybe I just haven't had enough caffeine this morning and it's already there).

This info should be added to the docs if it's not already there. Also, I think some sort of github template for reporting issues would help gather more information that could be used to resolve jscodeshift issues faster.

The more info we maintainers have, the less time we have to spend reproducing the bugs, the faster we can fix issues.

[Daniel15]

Also, I think some sort of github template for reporting issues would help gather more information that could be used to resolve jscodeshift issues faster.

+1

A link to an ast-explorer instance that sets up the transform (if relevant)

For issues that can be reproduced in ASTExplorer, it's one of the most useful things to have. Being able to click a link and see a bug, reproduced live, is so helpful for debugging.

[SeanKilleen]

Hey, just passing through for something unrelated and happened to see this thread.

Just wanted to say -- GitHub issues supports issues forms that could reliably collect the information you're seeking above.

https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms

Would you like a PR for that?