Based on various contributions (including Discussions, Issues, Pull Requests, and comments — also in private messages asking for help), I would like to improve a few things where I feel the contributors have the most difficulty (or that I notice, even when nothing is said).

These are my ideas:

Contributors

Contributing

• Including a template when opening Issues and Pull Requests.
• In addition to the Contribution Guide, I believe it's really useful to have tips on how to create and modify tests for features and fixes.
• docs: include instructions to LLM agents #4185

Automations

Several issues remain open because they have no way of being reproduced. For some time now, I have categorized them by adding a label to identify them, but it doesn't send a notification to the person who opened the Issue or a "formal request".

• I'd suggest an automation to create a default comment asking for a "basic repro" on Issues that need reproduction after adding this label. It would be of great help and, as it is triggered manually, it wouldn't cause any spam.

Testing

I think that reworking the test flow to be more practical/familiar is a good starting point:

• Unite all tests to /test/esm/ (so, just /test/ — no more mixed tests between CJS/require and ESM/import).
  • chore: support Docker testing locally #4019
  • ci: simplify esm tests #4085
  • ci: transcribe esm tests to TypeScript #4086
  • ci: transcribe cjs tests to ES Modules and TypeScript #4091
  • ci: simplify tests #4092
  • ci: add support for parallel runs #4094
  • chore: remove legacy tests #4102
  • Migrate tsc-build tests
    • ci: remove redundant type tests #4119
    • Create real tests to remaining build tests

Users

Bun and Deno

• It's interesting to include the installation guide for these runtimes too, as well as highlighting some possible differences in use between them (e.g., @types/node conflict for Deno with TypeScript).

Documentation

• Refer to the mysqljs/mysql documentation for sections and features that aren't present in the MySQL2 documentation, suggesting contributions for their inclusion.
  • This also includes opening a dedicated Issue for unimplemented features, if found.
• I also consider that we could include a /llms.txt with instructions in the website on where critical functions are and their use, directing the documentation with an improved NLP for AI users and editors.