Gene Curator is an open-source platform for managing and curating genetic data. It facilitates gene data analysis, entry, and reporting, serving genetics researchers with tools for efficient data handling.
Summary
Implement semantic versioning for the app, including the last commit hash, and display this information in the app's NavBar. This will provide clarity on the app's current version, ensure consistent progression, and help users and developers identify the build they are working with.
Description
Semantic versioning is a widely accepted system of version numbering aimed at making it easier to manage versions and dependencies. It is especially crucial for continuously updated applications, ensuring that the versioning conveys the significance of the changes made. Displaying the version and the last commit hash in the NavBar provides users and developers with immediate visibility into the build they are interacting with, which is crucial for troubleshooting, feedback, and development.
Acceptance Criteria
The app follows semantic versioning guidelines: MAJOR.MINOR.PATCH.
The version number updates automatically with each release.
The last commit hash is included in the versioning information to identify the exact state of the codebase.
The version and commit hash are displayed in a discreet yet easily accessible section of the NavBar.
Users and developers can easily copy the version and commit hash information for reporting and reference purposes.
User Stories
As a developer, I want to understand the app's version and the last changes made so that I can troubleshoot issues effectively.
As a user, when reporting a bug or issue, I want to reference the app version and commit hash so that the development team can pinpoint the problem more quickly.
As a project manager, I want the app to follow semantic versioning to streamline updates, patches, and new releases.
Implementation Details
Set up a script or tool that automatically updates the version number based on the type of changes made: major, minor, or patch.
Include the last commit hash in the versioning script to be retrieved and displayed alongside the version number.
Designate a place in the NavBar where the version and commit hash can be displayed unobtrusively yet accessibly.
Ensure the version and commit hash are easy to copy from the NavBar.
Summary
Implement semantic versioning for the app, including the last commit hash, and display this information in the app's NavBar. This will provide clarity on the app's current version, ensure consistent progression, and help users and developers identify the build they are working with.
Description
Semantic versioning is a widely accepted system of version numbering aimed at making it easier to manage versions and dependencies. It is especially crucial for continuously updated applications, ensuring that the versioning conveys the significance of the changes made. Displaying the version and the last commit hash in the NavBar provides users and developers with immediate visibility into the build they are interacting with, which is crucial for troubleshooting, feedback, and development.
Acceptance Criteria
User Stories
Implementation Details