Skip to content

Commit

Permalink
update release notes
Browse files Browse the repository at this point in the history
Signed-off-by: Jose Borreguero <[email protected]>
  • Loading branch information
jmborr committed Jul 26, 2024
1 parent 0778686 commit 4fd6d57
Show file tree
Hide file tree
Showing 2 changed files with 86 additions and 14 deletions.
29 changes: 18 additions & 11 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,28 @@
## Description of the changes
## Description of work:

Check all that apply:
- [ ] added [release notes](https://reflectivity-ui.readthedocs.io/en/latest/releasenotes/index.html)
(if not, provide an explanation in the work description)
- [ ] updated documentation
- [ ] Source added/refactored
- [ ] Added unit tests
- [ ] Added integration tests
- [ ] Verified that tests requiring the /SNS and /HFIR filesystems pass without fail

**References:**
<!-- Links to related issues or pull requests -->
<!-- Links to IBM EWM items if aaplicable -->
- Links to IBM EWM items:
- Links to related issues or pull requests:


## Manual test for the reviewer
<!-- Instructions for testing here. -->
# Manual test for the reviewer
([instructions to set up the environment](https://reflectivity-ui.readthedocs.io/en/latest/developer/environment.html))

## Check list for the reviewer
# Check list for the reviewer
- [ ] [release notes](https://reflectivity-ui.readthedocs.io/en/latest/releasenotes/index.html) updated,
or an explanation is provided as to why release notes are unnecessary
- [ ] best software practices
+ [ ] clearly named variables (better to be verbose in variable names)
+ [ ] code comments explaining the intent of code blocks
- [ ] All the tests are passing
- [ ] The documentation is up to date
- [ ] code comments added when explaining intent
-
## Check list for the pull request
- [ ] source refactored/incremented
- [ ] tests for my changes
- [ ] updated the documentation accordingly
71 changes: 68 additions & 3 deletions docs/releasenotes/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,72 @@
Release notes
.. release_notes
Release Notes
=============
Notes for major and minor releases. Notes for Patch releases are deferred.

v3.0.0

<Next Major or Minor Release>
--------------
(date of release, format YYYY-MM-DD)

**Of interest to the User**:

- MR #XYZ: one-liner description

**Of interest to the Developer:**

- MR #XYZ: one-liner description


v3.2.0
------
2023-11-04

**Of interest to the User**:

- MR #96 drop functionality to save files in genx format
- MR #94 fallback option for loading old data runs
- MR #93 change the default size of the smoothing area, and to change the color map on the preview plot
- MR #77 Clearly distinguish global and per-run options
- MR #75 Export direct beam data
- MR #74 Add plot toolbar buttons for log x-axis, log y-axis and R*Q^4
- MR #73 Make messages in status bar disappear after 10 seconds


**Of interest to the Developer:**

- MR #88 Recalculate and replot reflectivity when global config is changed
- MR #79 Update codecov version and add token in actions.yml
- MR #78 Add ConfigurationHandler which connects signals from global configuration parameter UI widgets to callbacks
- MR #71 disable automatic Conda deployments


v3.1.0
------
2023-10-13

**Of interest to the User**:

- MR #67 Adjust the reduction table to make all data visible
- MR #66 Display error message when "Normalize to unity when stitching" fails
- MR #64 Stitching by fitting a polynomial
- MR #63 Bugfix: Losing direct beam run
- MR #61 Correct error bars of stitched reflectivity curves
- MR #60 Publish documentation
- MR #58 Global stitching
- MR #52 Bugfix error in the x vs TOF plot for empty reflectivity curves
- MR #51 Fix plot of smooth off-specular area
- MR #48 Fix broken IO when saving off-specular data

Work-in-progress, will update the announcement when it's ready.

**Of interest to the Developer:**

- MR #57 Remove class ApplicationConfiguration
- MR #54 Unit testing for stitching
- MR #46 Update enviroment.yml with mantidworkbench


v3.0.0
------
2023-04-25

0 comments on commit 4fd6d57

Please sign in to comment.