Skip to main content
US Army Corps of EngineersInstitute for Water Resources, Risk Management Center

Merging to Main

Merge Requirements​

Before merging, ensure:

  1. Repository-specific review requirements are complete
  2. Branch is up to date with main
  3. No merge conflicts
  4. Current required CI checks pass

Merge Process​

GitHub web interface (recommended):

  1. Click "Merge"
  2. Edit the commit message to be clear and descriptive
  3. Confirm merge
  4. Delete the source branch automatically (check the box)

Use the repository's protected pull-request merge control. Do not bypass it by pushing a local merge to main.

Post-Merge​

Immediately after merging:

  1. Delete the feature branch (automated via GitHub)
  2. Verify main branch builds successfully
  3. Monitor for any issues in deployed environments
  4. Close any linked issues if not automatically closed

For the RMC Software Documentation repository, only administrators merge to main. Conversation replies and thread resolution are not mandatory gates. A successful merge starts the automatic main production build, which still requires administrator environment approval.

If something breaks:

  1. Create hotfix branch immediately
  2. Fix the issue
  3. Create a PR (can be fast-tracked)
  4. Merge after quick review
  5. Consider reverting the original PR if the hotfix is complex