Skip to content

Git and GitHub Workflow

Jump to bottom
Elliot Gould edited this page Apr 10, 2026 · 1 revision

Commit Messages, versioning and releases

From https://github.com/metamelb-repliCATS/aggreCAT/issues/7#issue-1359668248:

I have added the new NEWS.md file and versioning tags. When adding messages to commits it will look for bulleted messages and add these to the news file and update the version in the DESCRIPTION and add a tag. This will allow us to track releases easier. More info here.

Basically,

  • Make edits
  • Commit and use bullet points for key tasks in the commit message
  • run fledge::bump_version()
  • This will update the NEWS.md
  • run fledge::finalize_version(push = TRUE)

Branching

  • main branch should not be directly edited
  • feature branches should be branched of dev, then dev pulled onto main when production ready

Clone this wiki locally