Skip to content

Commit 7861adf

Browse files
authored
Add git branching information to AGENTS.md (#3726)
1 parent 5bce5ad commit 7861adf

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

AGENTS.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,24 @@ C++17/Python codebase where:
3131
- **Depletion**: `openmc.deplete` implements burnup via operator-splitting with various integrators (Predictor, CECM, etc.)
3232
- **Nuclear Data**: `openmc.data` provides programmatic access to nuclear data files (ENDF, ACE, HDF5)
3333

34+
## Git Branching Workflow
35+
36+
OpenMC uses a git flow branching model with two primary branches:
37+
38+
- **`develop` branch**: The main development branch where all ongoing development takes place. This is the **primary branch against which pull requests are submitted and merged**. This branch is not guaranteed to be stable and may contain work-in-progress features.
39+
- **`master` branch**: The stable release branch containing the latest stable release of OpenMC. This branch only receives merges from `develop` when the development team decides a release should occur.
40+
41+
### Instructions for Code Review
42+
43+
When analyzing code changes on a feature or bugfix branch (e.g., when a user asks "what do you think of these changes?"), **compare the branch changes against `develop`, not `master`**. Pull requests are submitted to merge into `develop`, so differences relative to `develop` represent the actual proposed changes. Comparing against `master` will include unrelated changes from other features that have already been merged to `develop`.
44+
45+
### Workflow for contributors
46+
47+
1. Create a feature/bugfix branch off `develop`
48+
2. Make changes and commit to the feature branch
49+
3. Open a pull request to merge the feature branch into `develop`
50+
4. A committer reviews and merges the PR into `develop`
51+
3452
## Critical Build & Test Workflows
3553

3654
### Build Dependencies

0 commit comments

Comments
 (0)