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

Update required packages and specify in DESCRIPTION #22

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

nolmacdonald
Copy link
Contributor

Reference: Issue #17

REASON

All current code needs to be reformatted to follow the Tidyverse Style Guide.
This will allow for cleaner code and use of the linter + styling.

DESIGN

  • Look at acceptable code for loops, spacing, embracing, etc.
  • Documentation should follow guide when discussing packages
  • importFrom may be helpful
  • Should add NEWS.md at this point in development
  • Follow Git commit messages recommendations
  • Change helpers to follow error messages style. Uses cli::cli_abort()
    • An error message should start with a general statement of the problem then give a concise description of what went wrong. Consistent use of punctuation and formatting makes errors easier to parse.
  • Issue with .data$ may be resolved with select(all_of(var)). See tidyverse blog post
  • Also add changes to git templates so that labels are automatically assigned

IMPACT

Nothing new, just cleaned up code for the nuclearff package.

@nolmacdonald nolmacdonald added bug Something isn't working documentation Improvements or additions to documentation labels Oct 10, 2024
@nolmacdonald nolmacdonald self-assigned this Oct 10, 2024
@nolmacdonald nolmacdonald linked an issue Oct 10, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] Reformat Code to Follow Tidyverse Style
1 participant