ISISComputingGroup / ISISComputingGroup/IBEX

Release notes: discuss the best way of documenting how changes will affect certain instruments

Open
#6,419 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
6
Forks
2
Avg merge
16h 40m
Merged PRs (30d)
2

Description

As an instrument scientist I would like to be able to check the release notes and easily tell if my instrument will be affected by certain changes.

Currently instrument scientists can most likely guess if their instrument will be affected by checking the changes against their own devices however in the Muons demo of release version 7.4.0 the EMU scientists stated they would like to be able to search for EMU and be told if their instrument would be affected by any of the changes in the release notes.

A suggestion from the scientists was to create release notes for each instrument, however the admin overhead of this would likely slow down development hugely.

Another option could be to tag the changes that are put into the release notes per ticket with the instruments they may affect, though this also has a large overhead because a minor eurotherm change for example may affect most instruments and would require checking and listing them which may take longer than the existing ticket.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.