Skip to content

Package development

Daniel Mork edited this page May 22, 2024 · 1 revision

General guidelines for package development.

  • Use development branch for all non-critical bug fixes and feature updates. Document changes in NEWS file.
  • Use https://semver.org/ guidelines for versioning control. X.Y.Z correspond to Major.Minor.Patch updates. Increment in X indicates some non-backward compatible changes. Increment in Y indicates possible new features but is backwards compatible.
  • If non-backward compatible changes are introduced, they should be made in a new branch off of development that specifies a new Major version.
  • Only critical bug fixes should be pushed directly to master branch with increment patch version and pushed to CRAN. Non-critical bug fixes should move through the development branch to facilitate a more orderly update to the software.
  • When working on new features/bug fixes/etc, work on a branch off of development branch (not master). Write pull request back into development when complete. If you are also working on a separate branch off of development, you can pull to your branch any changes from development before creating a pull request back to development.

Clone this wiki locally