Files
bun.sh/.github/pull_request_template.md
2023-07-27 18:12:11 -07:00

2.0 KiB

What does this PR do?

  • Documentation or TypeScript types (it's okay to leave the rest blank in this case)
  • Code changes

How did you verify your code works?

Checklist

If JavaScript/TypeScript modules or builtins changed:

  • I ran make js and committed the transpiled changes
  • I or my editor ran Prettier on the changed files (or I ran bun fmt)
  • I included a test for the new code, or an existing test covers it

If Zig files changed:

  • I checked the lifetime of memory allocated to verify it's (1) freed and (2) only freed when it should be
  • I or my editor ran zig fmt on the changed files
  • I included a test for the new code, or an existing test covers it
  • JSValue used outside outside of the stack is either wrapped in a JSC.Strong or is JSValueProtect'ed

If new methods, getters, or setters were added to a publicly exposed class:

  • I added TypeScript types for the new methods, getters, or setters

If dependencies in tests changed:

  • I made sure that specific versions of dependencies are used instead of ranged or tagged versions

If functions were added to exports.zig or bindings.zig

  • I ran make headers to regenerate the C header file

If *.classes.ts files were added or changed:

  • I ran make codegen to regenerate the C++ and Zig code

If a new builtin ESM/CJS module was added:

  • I updated Aliases in module_loader.zig to include the new module
  • I added a test that imports the module
  • I added a test that require() the module