Skip to content

Test formatting#20

Open
cristinamullin wants to merge 27 commits intodevelopfrom
test-formatting
Open

Test formatting#20
cristinamullin wants to merge 27 commits intodevelopfrom
test-formatting

Conversation

@cristinamullin
Copy link
Copy Markdown
Owner

Pull Request Checklist

Preparation

  • Update your branch from the latest develop and resolve any merge conflicts

  • Before creating a pull request trigger the format-update GitHub Action on your branch to format the code

Documentation

  • Add/update inline and/or block comments to clarify complexity, context and intent

  • Add/update function documentation (roxygen), include working examples, build docs locally using devtools::document(), and inspect added/updated help pages for content and format

  • Add/update vignettes for corresponding changes in functionality, list these under articles in _pkgdown.yml, and ensure added/updated vignettes run and build with proper formatting locally

Maintenance & Data Refresh

  • Add new dependencies to DESCRIPTION and document appropriately

  • Run spelling maintenance in requiredMaintenance.R

  • If changes affect other package or the shiny app functions, update those impacted functions accordingly

  • If columns were added/updated, add/update them in RequiredCols.R

  • Run .TADA_UpdateRefFiles() and .TADA_UpdateExampleData() locally via MaintenanceScheduled.R or trigger the Component File Update GitHub Action

  • If new example data files were added, document them in ExampleData.R and include them in MaintenanceScheduled.R for regular refresh

Tests and checks

  • Add/update tests in tests/testthat to cover changes

  • Run devtools::test() to verify new and existing tests pass

  • Run devtools::check() and address any errors, warnings or notes

Pull Request Description

  • Includes a summary of the changes made

  • Includes relevant context/motivation

  • Includes links to related issues or pull requests (keywords like "Closes #issue_number" automatically close related issues when pull request is merged)

Review

  • Review the bot-commented coverage-report generated by test-coverage to confirm all changes are covered by tests

  • Review/accept any bot-suggested format changes

  • Request review from at least one developer team member

cristinamullin and others added 27 commits March 4, 2026 11:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant