Skip to main content
U.S. Army Corps of Engineers
®
US Army Corps of EngineersInstitute for Water Resources, Risk Management Center
Developer Resources

Pull Request Workflow

Before Creating a PR​

Pre-flight checklist:

  1. Branch is up to date with main
  2. Code builds without errors
  3. Manually tested the changes
  4. Removed debug code and console logs
  5. Updated documentation if needed
  6. Added or updated tests (when testing infrastructure exists)

Updating the Branch​

Before creating a PR, ensure the branch has the latest changes from main:

# From the feature branch
git checkout main
git pull origin main
git checkout feature/your-feature
git merge main

# Resolve any conflicts, test thoroughly
git push origin feature/your-feature

Creating a Pull Request​

warning

Check to see if GH can provide this template automatically when a PR is created. Otherwise it will not be used.

PR Title: Should match the primary change

  • Use conventional commit format: feat(scope): description
  • Be specific: "Add user export feature" not "Update users"

PR Description Template:

## Description

Brief summary of what this PR does and why.

## Type of Change

- [ ] New feature
- [ ] Bug fix
- [ ] Enhancement
- [ ] Refactor
- [ ] Documentation
- [ ] Hotfix

## Changes Made

- Bullet point list of specific changes
- Focus on what changed and why
- Include any design decisions

## Testing Performed

- Describe how the changes were tested
- List specific scenarios tested
- Note any edge cases considered

## Screenshots (if applicable)

Include before/after screenshots for UI changes

## Dependencies

List any new dependencies added or updated

## Breaking Changes

- [ ] Yes (describe below)
- [x] No

If yes, describe what breaks and migration path.

## Checklist

- [ ] Code builds without errors
- [ ] Manually tested all changes
- [ ] Updated documentation
- [ ] Removed debug code
- [ ] Branch is up to date with main

PR Size Guidelines​

  • Small PRs are better: Aim for 200-400 lines of changes maximum
  • Large changes: Break into multiple PRs when possible
  • If PR is large (>500 lines): Provide extra detailed description and consider scheduling a walkthrough

Linking Issues​

If the organization uses issue tracking:

  • Reference issues in PR description: Closes #123 or Fixes #456
  • Use GitHub keywords to auto-close issues on merge
Last updated on