Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Semantic Versioning Best Practice #175

Open
mgifford opened this issue Sep 15, 2021 · 1 comment
Open

Document Semantic Versioning Best Practice #175

mgifford opened this issue Sep 15, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation website Related to the general website

Comments

@mgifford
Copy link
Collaborator

Git offers semantic versioning - https://github.com/marketplace/actions/git-semantic-version

Not sure the most non-technical explanation of this but perhaps - https://medium.com/swlh/automatic-semantic-versioning-by-using-gitversion-9e22edecb116

Given that the important thing is to align with products and services, we should think through a few common scenarios and document them.

Dev versions

Many accessibility issues are identified and fixed in alpha, git or development versions of the code, prior to a formal release. If the issue queues are integrated with an OPAT then we are going to see issues which are on versions which are not yet fully baked.

Issues found post-release

It's normal to get users reporting issues against a particular release of the software. The bug might exist in version 2.3.2.1 but was mitigated in one way or another in 2.3.3.0. Either way, it is useful to add a bug to the earlier release so that it can be included in a comprehensive ACR.

SASS

It could be that there are multiple versions which have some differences between them which we would want to capture.

@mgifford mgifford added the documentation Improvements or additions to documentation label Jan 10, 2022
@mgifford
Copy link
Collaborator Author

Related to #269

@mgifford mgifford added the website Related to the general website label Jan 10, 2022
@danid123 danid123 changed the title Document Semantic Versioning Best Practoce Document Semantic Versioning Best Practice Jan 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation website Related to the general website
Projects
None yet
Development

No branches or pull requests

1 participant