From 88e5370bba3e2c811b79b16ede466b08dd57f9f5 Mon Sep 17 00:00:00 2001 From: vedhav Date: Thu, 11 May 2023 03:58:33 +0530 Subject: [PATCH 01/10] feat: adding the issue templates --- .github/ISSUE_TEMPLATE/01_bug_report.yml | 33 +++++++++++++++ .github/ISSUE_TEMPLATE/02_feature_request.yml | 41 +++++++++++++++++++ 2 files changed, 74 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/01_bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/02_feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/01_bug_report.yml b/.github/ISSUE_TEMPLATE/01_bug_report.yml new file mode 100644 index 00000000..bb70b4ab --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01_bug_report.yml @@ -0,0 +1,33 @@ +name: Bug Report +description: Something is not working correctly or is not working at all! +title: "Bug: " +labels: ["bug", "programming"] +body: + - type: markdown + attributes: + value: | + **Example:** Bug: xportr_format() does not assign SAS format for `DATE9.` variable level metadata + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us what were you expecting to happen before the bug? + placeholder: "A bug happened!" + validations: + required: true + - type: textarea + id: session-info + attributes: + label: Session Information + description: Use `sessionInfo()` in the R console to gather all the details of your environment when the bug happened. + placeholder: "Place the console output here" + validations: + required: false + - type: textarea + id: logs + attributes: + label: Reproducible Example + description: We love code that can reproduce the example. Check out [reprex](https://reprex.tidyverse.org/articles/reprex-dos-and-donts.html) + placeholder: "Please give us as many details as you can! The faster we can recreate the bug, the faster we can get a fix in the works. Warning, Error Messages and Screenshots are also great." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/02_feature_request.yml b/.github/ISSUE_TEMPLATE/02_feature_request.yml new file mode 100644 index 00000000..cf7ea559 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02_feature_request.yml @@ -0,0 +1,41 @@ +name: Feature Request +description: Enchancement to xportr functionality +title: "Feature Request: " +labels: ["enhancement", "programming"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature request! We love keeping xportr fresh! + - type: textarea + id: feature + attributes: + label: Feature Idea + description: Tell us your idea in as few words as possible + placeholder: "`xportr_validate` should do x, y and z" + validations: + required: true + - type: textarea + id: input + attributes: + label: Relevant Input + description: Can you provide what the inputs should look like? + placeholder: "What should the input look like? REMINDER: no patient level data or company sensitive information should be shared via this open public issue" + validations: + required: false + - type: textarea + id: output + attributes: + label: Relevant Output + description: Can you provide what the final output should look like? + placeholder: "What should the output look like? REMINDER: no patient level data or company sensitive information should be shared via this open public issue" + validations: + required: false + - type: textarea + id: code + attributes: + label: Reproducible Example/Pseudo Code + description: Can you provide a working example or a sketch of how the code should work? + placeholder: "We love example code and it will speed up the process! REMINDER: no patient level data or company sensitive information should be shared via this open public issue" + validations: + required: false From f291e9aae288da53634a7e78e966e2ed471a871c Mon Sep 17 00:00:00 2001 From: bs832471 Date: Thu, 11 May 2023 00:51:41 +0000 Subject: [PATCH 02/10] feat: #94 branch off main and implement PR templates --- .github/PULL_REQUEST_TEMPLATE/release.md | 22 +++++++++++++++++ .github/pull_request_template.md | 30 ++++++++++++++++++++++++ 2 files changed, 52 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/release.md create mode 100644 .github/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/release.md b/.github/PULL_REQUEST_TEMPLATE/release.md new file mode 100644 index 00000000..d15938a3 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/release.md @@ -0,0 +1,22 @@ +# Release Description + + +## Milestone + + +Milestone: + +# Release Checklist + + +- [ ] DESCRIPTION File version number has been updated +- [ ] DESCRIPTION file updated with New Developers (if applicable) +- [ ] NEWS.md has been updated and issues numbers linked +- [ ] README.md has been updated (if applicable) +- [ ] Vignettes have been updated (if applicable) +- [ ] Ensure all unit tests are passing +- [ ] Review https://r-pkgs.org/release.html for additional checks and guidance +- [ ] Use `rhub::check_for_cran()` for checking CRAN flavors before submission +- [ ] Use `usethis::use_revdep()` to check for any reverse dependencies +- [ ] GitHub actions on this PR are all passing +- [ ] Draft GitHub release created using automatic template and updated with additional details. Remember to click "release" after PR is merged. \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..a4786bff --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,30 @@ +### Thank you for your Pull Request! + +We have developed a Pull Request template to aid you and our reviewers. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the xportr codebase remains robust and consistent. + +### The scope of `{xportr}` + +`{xportr}`'s scope is to enable R users to write out submission compliant `xpt` files that can be delivered to a Health Authority or to downstream validation software programs. We see labels, lengths, types, ordering and formats from a dataset specification object (SDTM and ADaM) as being our primary focus. We also see messaging and warnings to users around applying information from the specification file as a primary focus. Please make sure your Pull Request meets this **scope of {xportr}**. If your Pull Request moves beyond this scope, please get in touch with the `{xportr}` team on [slack](https://pharmaverse.slack.com/archives/C030EB2M4GM) or create an issue to discuss. + +Please check off each task box as an acknowledgment that you completed the task. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the `devel` branch until you have checked off each task. + +### Changes Description + +_(descriptions of changes)_ + +### Task List + +- [ ] The spirit of xportr is met in your Pull Request +- [ ] Place Closes # into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update) +- [ ] Summary of changes filled out in the above Changes Description. Can be removed or left blank if changes are minor/self-explanatory. +- [ ] Check that your Pull Request is targeting the `devel` branch, Pull Requests to `main` should use the [Release Pull Request Template](https://github.com/atorus-research/xportr/tree/94_pr_template/.github/PULL_REQUEST_TEMPLATE) +- [ ] Code is formatted according to the [tidyverse style guide](https://style.tidyverse.org/). Use `styler` package and functions to style files accordingly. +- [ ] Updated relevant unit tests or have written new unit tests. See our [Wiki](https://github.com/atorus-research/xportr/wiki/Style-Guide-for-Unit-Tests) for conventions used in this package. +- [ ] Creation/updated relevant roxygen headers and examples. See our [Wiki](https://github.com/atorus-research/xportr/wiki/Style-Guide-for-Roxygen-Headers) for conventions used in this package. +- [ ] Run `devtools::document()` so all `.Rd` files in the `man` folder and the `NAMESPACE` file in the project root are updated appropriately +- [ ] Run `pkgdown::build_site()` and check that all affected examples are displayed correctly and that all new/updated functions occur on the "Reference" page. +- [ ] Update NEWS.md if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers) +- [ ] Address any updates needed for vignettes and/or templates +- [ ] Link the issue Development Panel so that it closes after successful merging. +- [ ] Fix merge conflicts +- [ ] Pat yourself on the back for a job well done! Much love to your accomplishment! From 495037d08505561360a167f400ee9c93c0d5d7a7 Mon Sep 17 00:00:00 2001 From: Ben Straub Date: Wed, 10 May 2023 20:55:22 -0400 Subject: [PATCH 03/10] fix: Update test-coverage.yaml to address failing CI --- .github/workflows/test-coverage.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml index 0a44f49a..dadf5abe 100644 --- a/.github/workflows/test-coverage.yaml +++ b/.github/workflows/test-coverage.yaml @@ -18,7 +18,7 @@ jobs: steps: - uses: actions/checkout@v3 - - uses: r-lib/actions/setup-r@v1 + - uses: r-lib/actions/setup-r@v2 - uses: r-lib/actions/setup-pandoc@v1 From 50d109dbad8956813a52225c45309785eae1856d Mon Sep 17 00:00:00 2001 From: vedhav Date: Thu, 11 May 2023 16:30:04 +0530 Subject: [PATCH 04/10] fix: update the r setup action to fix CI --- .github/workflows/pkgdown.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml index 07dea56d..16404107 100644 --- a/.github/workflows/pkgdown.yaml +++ b/.github/workflows/pkgdown.yaml @@ -14,7 +14,7 @@ jobs: steps: - uses: actions/checkout@v3 - - uses: r-lib/actions/setup-r@v1 + - uses: r-lib/actions/setup-r@v2 - uses: r-lib/actions/setup-pandoc@v1 From b19838da78101c5cff68390954b523820d840149 Mon Sep 17 00:00:00 2001 From: vedhav Date: Thu, 11 May 2023 16:33:26 +0530 Subject: [PATCH 05/10] fix: update the setup in spellcheck CI as well --- .github/workflows/spellcheck.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml index 353b9682..42c7e327 100644 --- a/.github/workflows/spellcheck.yml +++ b/.github/workflows/spellcheck.yml @@ -32,7 +32,7 @@ jobs: fetch-depth: 0 - name: Setup R 📊 - uses: r-lib/actions/setup-r@v1 + uses: r-lib/actions/setup-r@v2 with: r-version: 4.1.3 From f20899236c16065911ffea863b47d44456b97b82 Mon Sep 17 00:00:00 2001 From: Vedha Viyash <49812166+vedhav@users.noreply.github.com> Date: Thu, 11 May 2023 19:46:32 +0530 Subject: [PATCH 06/10] Update .github/ISSUE_TEMPLATE/01_bug_report.yml Co-authored-by: Ben Straub --- .github/ISSUE_TEMPLATE/01_bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/01_bug_report.yml b/.github/ISSUE_TEMPLATE/01_bug_report.yml index bb70b4ab..10800caf 100644 --- a/.github/ISSUE_TEMPLATE/01_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/01_bug_report.yml @@ -6,7 +6,7 @@ body: - type: markdown attributes: value: | - **Example:** Bug: xportr_format() does not assign SAS format for `DATE9.` variable level metadata + **Example:** Bug: xportr_format() does not assign SAS format for `DATE9.` metadata - type: textarea id: what-happened attributes: From 1f9d2d297cd540483582f10d14673bb02c6a1bb1 Mon Sep 17 00:00:00 2001 From: Vedha Viyash <49812166+vedhav@users.noreply.github.com> Date: Thu, 11 May 2023 19:46:38 +0530 Subject: [PATCH 07/10] Update .github/ISSUE_TEMPLATE/01_bug_report.yml Co-authored-by: Ben Straub --- .github/ISSUE_TEMPLATE/01_bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/01_bug_report.yml b/.github/ISSUE_TEMPLATE/01_bug_report.yml index 10800caf..c89cc92d 100644 --- a/.github/ISSUE_TEMPLATE/01_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/01_bug_report.yml @@ -27,7 +27,7 @@ body: id: logs attributes: label: Reproducible Example - description: We love code that can reproduce the example. Check out [reprex](https://reprex.tidyverse.org/articles/reprex-dos-and-donts.html) + description: We love code that can reproduce the bug. Check out [reprex](https://reprex.tidyverse.org/articles/reprex-dos-and-donts.html) placeholder: "Please give us as many details as you can! The faster we can recreate the bug, the faster we can get a fix in the works. Warning, Error Messages and Screenshots are also great." validations: required: false From 08aac591fa90fa33ea4d32e0028443d9d06f21ae Mon Sep 17 00:00:00 2001 From: Vedha Viyash <49812166+vedhav@users.noreply.github.com> Date: Thu, 11 May 2023 19:47:03 +0530 Subject: [PATCH 08/10] Update .github/ISSUE_TEMPLATE/02_feature_request.yml Co-authored-by: Ben Straub --- .github/ISSUE_TEMPLATE/02_feature_request.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/02_feature_request.yml b/.github/ISSUE_TEMPLATE/02_feature_request.yml index cf7ea559..927c80bd 100644 --- a/.github/ISSUE_TEMPLATE/02_feature_request.yml +++ b/.github/ISSUE_TEMPLATE/02_feature_request.yml @@ -20,7 +20,7 @@ body: attributes: label: Relevant Input description: Can you provide what the inputs should look like? - placeholder: "What should the input look like? REMINDER: no patient level data or company sensitive information should be shared via this open public issue" + placeholder: "What should the input look like? REMINDER: No patient level data or company sensitive information should be shared via this open public issue" validations: required: false - type: textarea From fa52c8806a9eac8c20e41636515f7b789c2f0f59 Mon Sep 17 00:00:00 2001 From: Vedha Viyash <49812166+vedhav@users.noreply.github.com> Date: Thu, 11 May 2023 19:47:11 +0530 Subject: [PATCH 09/10] Update .github/ISSUE_TEMPLATE/02_feature_request.yml Co-authored-by: Ben Straub --- .github/ISSUE_TEMPLATE/02_feature_request.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/02_feature_request.yml b/.github/ISSUE_TEMPLATE/02_feature_request.yml index 927c80bd..6a647481 100644 --- a/.github/ISSUE_TEMPLATE/02_feature_request.yml +++ b/.github/ISSUE_TEMPLATE/02_feature_request.yml @@ -28,7 +28,7 @@ body: attributes: label: Relevant Output description: Can you provide what the final output should look like? - placeholder: "What should the output look like? REMINDER: no patient level data or company sensitive information should be shared via this open public issue" + placeholder: "What should the output look like? REMINDER: No patient level data or company sensitive information should be shared via this open public issue" validations: required: false - type: textarea From 0635ab1890d77ee9c0d5c66e76ec821799f543a5 Mon Sep 17 00:00:00 2001 From: Vedha Viyash <49812166+vedhav@users.noreply.github.com> Date: Thu, 11 May 2023 19:47:18 +0530 Subject: [PATCH 10/10] Update .github/ISSUE_TEMPLATE/02_feature_request.yml Co-authored-by: Ben Straub --- .github/ISSUE_TEMPLATE/02_feature_request.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/02_feature_request.yml b/.github/ISSUE_TEMPLATE/02_feature_request.yml index 6a647481..e0b2597d 100644 --- a/.github/ISSUE_TEMPLATE/02_feature_request.yml +++ b/.github/ISSUE_TEMPLATE/02_feature_request.yml @@ -36,6 +36,6 @@ body: attributes: label: Reproducible Example/Pseudo Code description: Can you provide a working example or a sketch of how the code should work? - placeholder: "We love example code and it will speed up the process! REMINDER: no patient level data or company sensitive information should be shared via this open public issue" + placeholder: "We love example code and it will speed up the process! REMINDER: No patient level data or company sensitive information should be shared via this open public issue" validations: required: false