Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename testthat files #571

Merged
merged 4 commits into from
May 9, 2024
Merged

Rename testthat files #571

merged 4 commits into from
May 9, 2024

Conversation

k-doering-NOAA
Copy link
Member

What is the feature?

How have you implemented the solution?

This includes:

  1. renaming/combining testthat files that correspond with testing R files match the convention test-name_of_r_file.R
  2. renaming test of rcpp interface to the convention test-rcpp-description.R (where description describes the interface being tested.
  3. renaming integration tests (currently 1 file) to test-integration-description.R (where description describes the integration test).

Does the PR impact any other area of the project?

How to test this change

Make sure GitHub actions are passing and that filenames are as described

Developer pre-PR checklist

  • I relied on GitHub actions to 🧪 things for me while I sat on the 🛋️.

Copy link
Contributor

github-actions bot commented May 2, 2024

Instructions for code reviewer

Hello reviewer, thanks for taking the time to review this PR!

  • Please use this checklist during your review, checking off items that you have verified are complete!
  • For PRs that don't make changes to code (e.g., changes to README.md or Github actions workflows), feel free to skip over items on the checklist that are not relevant. Remember it is still important to do a thorough review.
  • Then, comment on the pull request with your review indicating where you have questions or changes need to be made before merging.
  • Remember to review every line of code you’ve been asked to review, look at the context, make sure you’re improving code health, and compliment developers on good things that they do.
  • PR reviews are a great way to learn, so feel free to share your tips and tricks. However, for optional changes (i.e., not required for merging), please include nit: (for nitpicking) before making the suggestion. For example, nit: I prefer using a data.frame() instead of a matrix because...
  • Engage with the developer when they respond to comments and check off additional boxes as they become complete so the PR can be merged in when all the tasks are fulfilled. Make it clear when this has been reached by commenting on the PR with something like This PR is now ready to be merged, no changes needed.

Checklist

  • The PR is requested to be merged into the appropriate branch (typically main)
  • The code is well-designed.
  • The functionality is good for the users of the code.
  • Any User Interface changes are sensible and look good.
  • The code isn’t more complex than it needs to be.
  • Code coverage remains high, indicating the new code is tested.
  • The developer used clear names for everything.
  • Comments are clear and useful, and mostly explain why instead of what.
  • Code is appropriately documented (doxygen and roxygen).

Copy link
Contributor

@kellijohnson-NOAA kellijohnson-NOAA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made two comments about the file names but other than that everything looks good to merge this into main tomorrow.

@kellijohnson-NOAA
Copy link
Contributor

@k-doering-NOAA I made two comments on this PR that I am not entirely sure if they are valid or not. Once those are addressed we can merge it in.

@k-doering-NOAA
Copy link
Member Author

@kellijohnson-NOAA sorry this took so long - I just replied to your comments. Feel free to decide based on my comments if the changes should be made and merge it in when ready (Or, I'm happy to make the changes if you prefer, just let me know what you think makes sense)!

@kellijohnson-NOAA kellijohnson-NOAA merged commit fe5836b into main May 9, 2024
11 checks passed
@kellijohnson-NOAA kellijohnson-NOAA deleted the rcpp-test-file branch May 9, 2024 15:47
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.

2 participants