Version control and release notes
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 0
- Forks
- 8
- Avg merge
- 44m
- Merged PRs (30d)
- 1
Description
Story
As a user of VHP4S
I want to know what functionality is available on the platform
So I can use this functionality
Background
The platform will not be delivered with a big bang, there will be many incremental releases. There is a need for showing which functionality is available on which version of the platform. Therefor, we need to show versioning and contents of these versions to the users.
Design notes
Idea: use the hamburger menu, add a link to a page 'Release Notes'
This page needs updating with each release.
Release notes need to show
- version number
- content of release (what is in this release)
- is it new functionality, is it an update of existing functionality, is it a bug fix
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing hamburger menu and page structure in the cloud service. Add a Release Notes entry showing each release's version number, contents, and whether changes are new functionality, updates, or bug fixes; done means users can reach the page and see those details for each release.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100