Merge 542431c into f0fe692

.github/pull_request_template.md

@@ -7,18 +7,19 @@
 <!-- MANDATORY: Explain why the change is necessary -->
 <!-- Optional: Link to any related GitHub Issues -->
 
+
 ---
 
 ## Checklist
 
 <!--
     You (the pull requester) should put an `x` in the boxes below you have completed.
-    If you're unsure about any of them, don't hesitate to ask. We're here to help!
-    (If a checkbox requires no action for this PR, put an `x` in the box.)
+
+    (If a checkbox doesn't apply to your PR, check it anyway.)
 -->
 
 - [ ] This PR has only [one purpose or idea](https://terrapower.github.io/armi/developer/tooling.html#one-idea-one-pr).
-- [ ] [Tests](https://terrapower.github.io/armi/developer/tooling.html#test-it) have been added/updated to verify that the new/changed code works.
+- [ ] [Tests](https://terrapower.github.io/armi/developer/tooling.html#test-it) have been added/updated to verify any new/changed code.
 
 <!-- Check the code quality -->
 
@@ -27,7 +28,6 @@
 
 <!-- Check the project-level cruft -->
 
-- [ ] The [release notes](https://terrapower.github.io/armi/release/index.html) (location `doc/release/0.X.rst`) are up-to-date with any important changes.
+- [ ] The [release notes](https://terrapower.github.io/armi/developer/tooling.html#add-release-notes) have been updated if necessary.
 - [ ] The [documentation](https://terrapower.github.io/armi/developer/tooling.html#document-it) is still up-to-date in the `doc` folder.
-- [ ] If any [requirements](https://terrapower.github.io/armi/developer/tooling.html#watch-for-requirements) were affected, mention it in the [release notes](https://terrapower.github.io/armi/release/index.html).
-- [ ] The dependencies are still up-to-date in `pyproject.toml`.
+- [ ] The dependencies are still up-to-date in `pyproject.toml`.

armi/bookkeeping/db/layout.py

@@ -603,7 +603,7 @@ def _packLocationsV1(
 def _packLocationsV2(
     locations: List[grids.LocationBase],
 ) -> Tuple[List[str], List[Tuple[int, int, int]]]:
-    """Location packing implementation for minor version 3. See release notes above."""
+    """Location packing implementation for minor version 3. See module docstring above."""
     locTypes = []
     locData: List[Tuple[int, int, int]] = []
     for loc in locations:
@@ -630,7 +630,7 @@ def _packLocationsV2(
 def _packLocationsV3(
     locations: List[grids.LocationBase],
 ) -> Tuple[List[str], List[Tuple[int, int, int]]]:
-    """Location packing implementation for minor version 4. See release notes above."""
+    """Location packing implementation for minor version 4. See module docstring above."""
     locTypes = []
     locData: List[Tuple[int, int, int]] = []
 
@@ -689,7 +689,7 @@ def _unpackLocationsV1(locationTypes, locData):
 
 
 def _unpackLocationsV2(locationTypes, locData):
-    """Location unpacking implementation for minor version 3+. See release notes above."""
+    """Location unpacking implementation for minor version 3+. See module docstring above."""
     locsIter = iter(locData)
     unpackedLocs = []
     for lt in locationTypes:

doc/developer/tooling.rst

@@ -105,6 +105,26 @@ call out that you touch such a code in your PR.
 Your PR reviewer will take an extra look at any PR that touches a requirement test or implementation.
 And you will need to add a special release note under the "Changes that Affect Requirements" section header.
 
+Add Release Notes
+-----------------
+For most PRs, you will need to add release notes to the
+`Release Notes documentation <https://github.com/terrapower/armi/tree/main/doc/release>`_. The goal
+here is to help track all the important changes that happened in ARMI, so ARMI can document what
+has changed during the next `release <https://github.com/terrapower/armi/releases>`_. To that end,
+minor PRs won't require a release note.
+
+In particular, in the release notes, you will find four sections in the releasee notes:
+
+1. **New Features** - A new feature (or major addition to a current feature) was added to the code.
+2. **API Changes** - ANY change to the public-facing API of ARMI.
+3. **Bug Fixes** - ANY bug fix in the code (not the documentation), no matter how minor.
+4. **Changes that Affect Requirements** - If you touch the code (``impl``) or test (``test``) for
+   anything that currently has a requirement crumb. (This must be a non-trivial change.)
+
+If your PR fits more than one of these categories, great! Put a description of your change under
+all the categories that apply.
+
+
 Packaging and dependency management
 ===================================
 The process of packaging Python projects and managing their dependencies is somewhat

doc/release/0.3.rst

@@ -6,8 +6,8 @@ ARMI v0.3.1
 ===========
 Release Date: TBD
 
-What's new in ARMI?
--------------------
+New Features
+------------
 #. TBD
 
 API Changes