2. Development Conventions

This project uses the following coding styles, unit testing packages, and docstrings. New contributions to the code repository should follow these conventions.

python

• Please read pep8 style guide and raise any concerns
• google python style guide
• unit testing: unittest
• docstring convention: sphinx

R

• MUST use namespacing for all external functions, e.g. the dplyr:: in dplyr::filter()
• tidyverse style guide
• google R style guide
• docstring: roxygen2 documentation
• unit testing: testthat

Package design

Run the dependency_grapher.R to interactively visualize the package layout. Note proc_attr_wrap is deprecated.

yaml

• Name objects in R and python using the same name used in yaml config files to avoid confusion when reading R and python code

git

As a best practice, follow the semantics of conventional commits

The dev branch represents the latest developments prior to merging into main.

• Procedure to avoid the growing commit list, in the case that NOAA-OWP/formulation-selector is the origin. Alternatively this may be upstream instead depending on how you have your repos set up. You may determine upstream vs origin usage with git remote -v

  git checkout dev
  git fetch origin
  git rebase origin/main
  

In the case of RaFTS, say we want to make sure a feature branch is based on dev in your upstream repo, then it may look like this:

 git checkout -b feature_branch dev
 git fetch upstream
 git rebase upstream/dev