From fd02b56d2b3936d466fb8888c44a4041a6c00f6c Mon Sep 17 00:00:00 2001 From: shakedregev Date: Wed, 12 Nov 2025 22:28:01 +0000 Subject: [PATCH 1/3] [skip ci] PR template updates --- .github/pull_request_template.md | 8 +++++++- CHANGELOG.md | 4 +++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 979123f5..c2dc2659 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -21,7 +21,13 @@ to help! This is simply a reminder of what we are going to look for before merging your code._ -- [ ] All tests pass. Code tested on + +- [ ] All tests pass (`ctest -j` in your `build` directory). Code tested on + - [ ] CPU backend + - [ ] CUDA backend + - [ ] HIP backend +- [ ] I have manually run the non-experimental examples and verified that residuals are close to machine precision. (In your build directory run: +`./examples/.exe -m -r -n -b `). Code test on: - [ ] CPU backend - [ ] CUDA backend - [ ] HIP backend diff --git a/CHANGELOG.md b/CHANGELOG.md index a112d7a3..94e8b51c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,9 @@ ## Changes to Re::Solve since release 0.99.2 -- Added cmake-format +- Added cmake-format. + +- Reworked templates to include example tests. ## Changes to Re::Solve in release 0.99.2 From c426d784797b65dbba2732428b8ab97d8e4a669e Mon Sep 17 00:00:00 2001 From: shakedregev Date: Wed, 12 Nov 2025 22:32:22 +0000 Subject: [PATCH 2/3] [skip ci] PR template updates --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c2dc2659..fd0888f1 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -27,7 +27,7 @@ - [ ] CUDA backend - [ ] HIP backend - [ ] I have manually run the non-experimental examples and verified that residuals are close to machine precision. (In your build directory run: -`./examples/.exe -m -r -n -b `). Code test on: +`./examples/.exe -m -r -n -b `). Code tested on: - [ ] CPU backend - [ ] CUDA backend - [ ] HIP backend From 79e2be429e4824660d86535905059eb5c3b830a9 Mon Sep 17 00:00:00 2001 From: pelesh Date: Thu, 18 Dec 2025 10:36:51 -0500 Subject: [PATCH 3/3] Write instructions on how to make a PR as HTML comments --- .github/pull_request_template.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index fd0888f1..5fbff7ac 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,33 +1,33 @@ ## Description - _Please describe the issue that is addressed (bug, new feature, + - _Closes # (issue)_ + - _Mentions @(user)_ + ## Proposed changes - _Describe how your changes here address the issue and why the proposed changes - should be accepted._ + ## Checklist - _Put an `x` in the boxes that apply. You can also fill these out after creating + -- [ ] All tests pass (`ctest -j` in your `build` directory). Code tested on +- [ ] All tests pass (`make test` and `make test_install` per testing [instructions](https://github.com/ORNL/ReSolve?tab=readme-ov-file#test-and-deploy)). Code tested on - [ ] CPU backend - [ ] CUDA backend - [ ] HIP backend - [ ] I have manually run the non-experimental examples and verified that residuals are close to machine precision. (In your build directory run: -`./examples/.exe -m -r -n -b `). Code tested on: +`./examples/.exe -h` to get instructions how to run examples). Code tested on: - [ ] CPU backend - [ ] CUDA backend - [ ] HIP backend @@ -40,5 +40,5 @@ ## Further comments - _If this is a relatively large or complex change, kick off the discussion by explaining - why you chose the solution you did and what alternatives you considered, etc._ +