Skip to content

Commit 5ccfa5c

Browse files
committed
added PR template
1 parent 039536a commit 5ccfa5c

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

PULL_REQUEST_TEMPLATE.md.R

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## Instructions & checklist for PR author
2+
3+
### Description of changes
4+
[Add a description of what they have changed]
5+
6+
### Refactor instructions
7+
- [ ] Removed `exists` and `isDefined` from clientside function and add appropriate checks on server-side function
8+
- [ ] Removed any client-side code checking whether an object has been successfully created
9+
- [ ] Reviewed code to determine if additional refactoring could reduce calls to server-side package
10+
- [ ] Replaced check relating to datashield connections object with `.set_datasources()` (defined in `utils.r`)
11+
- [ ] If relevant, replaced argument check that dataset name has been provided to `.check_df_name_provided()` (defined in `utils.r`)
12+
13+
### Testing instructions
14+
- [ ] Writen client-side unit tests for unhappy flow
15+
- [ ] Run `devtools::test(filter = "smk-|disc|arg")` and check it passes
16+
- [ ] Run `devtools::check(args = '--no-tests')` and check it passes (we run tests separately to skip performance checks)
17+
- [ ] Run `devtools::build()` and check it builds without errors
18+
19+
## Instructions & checklist for PR reviewers
20+
- [ ] Checkout this branch as well as the corresponding branch of dsBase
21+
- [ ] Review the code and suggest any changes
22+
- [ ] Install the dsBase branch on an Armadillo or Opal test server
23+
- [ ] Run `devtools::test(filter = "smk-|disc|arg")` and check it passes
24+
- [ ] Run `devtools::check(args = '--no-tests')` and check it passes (we run tests separately to skip performance checks)
25+
- [ ] Run `devtools::build()` and check it builds without errors

0 commit comments

Comments
 (0)