about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJubilee Young <workingjubilee@gmail.com>2020-10-01 18:09:59 -0700
committerJubilee <46493976+workingjubilee@users.noreply.github.com>2020-10-01 19:50:49 -0700
commit9028cdde147b3649888b1c11bd4e0d267f85cbef (patch)
treea268259bc64e0cf1679cecbec34df2d3b8047173
parent43dabd1aeabe02c3404c76a8c62f29b55f1d1c7c (diff)
downloadrust-9028cdde147b3649888b1c11bd4e0d267f85cbef.tar.gz
rust-9028cdde147b3649888b1c11bd4e0d267f85cbef.zip
Offer a checklist for math PRs
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000000..31422b79345
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,18 @@
+Hello, welcome to `std::simd`!
+
+It seems this pull request template checklist was created while a lot of vector math ops were being implemented, and only really applies to ops. Feel free to delete everything here if it's not applicable, or ask for help if you're not sure what it means!
+
+For a given vector math operation on TxN, please add tests for interactions with:
+  - [ ] `T::MAX`
+  - [ ] `T::MIN`
+  - [ ] -1
+  - [ ] 1
+  - [ ] 0
+
+
+For a given vector math operation on TxN where T is a float, please add tests for test interactions with:
+  - [ ] a really large number, larger than the mantissa
+  - [ ] a really small "subnormal" number
+  - [ ] NaN
+  - [ ] Infinity
+  - [ ] Negative Infinity