aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Jarred Sumner <709451+Jarred-Sumner@users.noreply.github.com> 2023-07-27 17:55:57 -0700
committerGravatar Jarred Sumner <709451+Jarred-Sumner@users.noreply.github.com> 2023-07-27 17:56:11 -0700
commit6b35fd847f7377c96f05d2ce3d55cecb66177773 (patch)
tree752f6b215e7b324a4247b89451ecc3aa6e8b96fd
parent007f357495d02ccccc4a75f6f04a7e127d022a72 (diff)
downloadbun-6b35fd847f7377c96f05d2ce3d55cecb66177773.tar.gz
bun-6b35fd847f7377c96f05d2ce3d55cecb66177773.tar.zst
bun-6b35fd847f7377c96f05d2ce3d55cecb66177773.zip
Create pull_request_template.md
-rw-r--r--.github/pull_request_template.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 000000000..4090cc4bf
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,47 @@
+# What does this PR do?
+
+**Please include a description of the changes**
+
+- [ ] Documentation or TypeScript types (it's okay to leave the rest blank in this case)
+- [ ] Code changes
+
+# How did you verify your code works?
+
+<!-- For code changes, please include automated tests. Feel free to uncomment the line below -->
+
+<!-- I wrote automated tests -->
+
+## Checklist
+
+**Please delete the sections which are not relevant, including this line. If there were no code changes, feel free to delete or ignore this section entirely**
+
+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 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