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

format C++ code with clang format #728

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

ChristineStawitz-NOAA
Copy link
Contributor

Copy link
Contributor

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).

Bai-Li-NOAA and others added 5 commits January 17, 2025 07:07
* update the DESCRIPTION file and set Config/testthat/parallel to false.
  This addresses the GHA run-time issue.
* skip parallel tests when running covr::package_coverage(), as these tests
  don't contribute to increasing code coverage and are redundant due to
  the reuse of wrapper functions. Integration tests are sufficient for
  coverage calculation.
* update GHA build triggers.

Co-authored-by: Kathryn Doering <[email protected]>
Now that the fix to allcontributors is in. Thanks @iantaylor-NOAA

Changes commit message to "chore: Updates contributors" to add a descriptor and make the tense present.

PR on dev rather than main, which main is the default and nothing was declared. But we don't want any PR to main.

Updates to use v4 of actions and v7 of create-pull-request
fix(GHA): Updates GHA build triggers

* update to v4 of upload-artifact gha
* fix(clang-format): v18 of workflow; allows for the newest version of clang-format to always be used by removing the clang-format version specification. This might be causing the issues with clang-format reordering the libraries and things
crashing on the R side when the package is tested.
* refactor(build-doxygen): Uses one file with an if statement to know if the doxygen workflow should deploy after building now that it is built on changes to both dev and main.
* fix(call-calc-coverage): Ignores paths on push and PR; it was ignoring paths just on workflow dispatch. Now the ignore calls are there for both PR and pushes.
* Adds dependabot.yml file to update GitHub actions
* Removes tags as trigger in package down
* Formats the GitHub action yml files consistently; moves summary above name: and arrange on in alphabetical order, as well as branch names and files are now in order too. This standardizes the way that the files are written.

References:
* https://kevsoft.net/2020/06/10/running-github-action-steps-and-jobs-only-on-push-to-master.html
* https://stackoverflow.com/questions/58139406/only-run-job-on-specific-branch-with-github-actions

Co-authored-by: Bai-Li-NOAA <[email protected]>
Co-authored-by: kellijohnson-NOAA <[email protected]>
results <- styler::style_pkg() which uses 4 spaces but it will be okay
until it adopts the new new rules.
* update tests to use FIMS_dmultinom for length comps

* remove TODO comments
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.

5 participants