-
Notifications
You must be signed in to change notification settings - Fork 3
Release Notes
Maintaining accurate and concise release notes is important for several reasons including:
-
Effectively communicating change to end users. This helps users to understand when fixes and new features become available and helps to keep users engaged with the product and development team.
-
Acts as an additional source for debugging information. This helps the development team pinpoint which feature or fixes introduced a new bug.
-
Functions as a historical record for the development team to identify patterns of defects - especially repeated defects.
Releases are identified by the date of the release rather than by release numbers. devGaido employs a policy of releasing fixes and new features frequently rather than on a fixed time schedule (e.g. monthly or quarterly). The reasoning behind this is we want these to be available to our users as quickly as possible.
Each new release of devGaido must be accompanied by the promotion of the corresponding source code from the development branch to master in GitHub and an update to the contents of the releasenotes.md file in GitHub. New entries are added to the top of this file start with the date of the release followed by a 'New Features' section listing each new feature added to the release and a 'Fixes' section listing each defect resolved in the release. Defect resolutions should include the GitHub Issue number that was resolved.
Items in these lists should be clear and concise. They should describe the change in language that is meaningful to the end user, not to the developer.