github branch, merge process - ESCOMP/mizuRoute GitHub Wiki

Note on branches

You will see 5 branches in ESCOMP/mizuRoute repository:

1. main branch

  • MPI parallel version. Pull request from other branches for merging and tagged as version from this branch.

  • cesm-coupling branch was copied to this in July 2 2025, for further development.

2. serial branch (inactive)

  • Pprevious main branch was renamed to this on July 2nd 2025, and locked since then.

3. cesm-coupling branch (inactive)

  • This branch was copied to main on July 2nd 2025, and cesm-coupling has been locked (no more changes allowed).

4. gh-pages

  • github page for webpage (not very active)

5. JAMS2021_mizukame_et_al

  • The code used for Mizukami et al., 2021 JAME (locked)

Pleas see how to rename a branch in git to understand how the branches were renamed and the consequences

Please see discussion #540

Note on pull-request

Merging branches in ESCOMP require pull-request. No direct merge by git push is allowed (it is blocked)

Current practice:

Pull-request a working branch in personal git repository to main branch under ESCOMP/mizuRoute.

Previous practice:

Used develop branch. Pull-request a working branch in personal git repository to develop branch, and when develop branch is ready to be tagged, execute pull request ESCOMP/develop to ESCOMP/main at remote git repository, add adequate notes (see example of previous pull-request). The title of pull-request is version name. Then perform merge (no squash, no rebase, so include merge commit).

As more developer wants to PR to main branch, we consider restoring develop branch and this practice again.