[FOLIO-2232] Spike: Gather existing guidelines for version numbers, naming conventions, etc. Created: 29/Aug/19  Updated: 03/Jun/20  Resolved: 30/Aug/19

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Task Priority: TBD
Reporter: David Crossley Assignee: David Crossley
Resolution: Done Votes: 0
Labels: devdoc, platform-backlog
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Relates
relates to FOLIO-2214 New dev.folio.org docs regarding the ... Closed
Sprint: CP: sprint 71
Story Points: 1
Development Team: Core: Platform

 Description   

We need to clearly document instructions about when to change numbers relating to interfaces and implementations, and for various naming conventions.

Use this ticket to gather existing instructions.

Then we can decide whether to expand those documents, consolidate, or to create additional summary documents, etc.



 Comments   
Comment by David Crossley [ 29/Aug/19 ]

Interface compatibility (when is a change interface breaking)

https://dev.folio.org/guidelines/contributing/#apiinterface-versions

Implementation compatibility (when is a change implementation breaking)

https://dev.folio.org/guidelines/contributing/#implementation-versions

Interface version numbers (when and how should interface versions change)

https://dev.folio.org/guidelines/contributing/#version-numbers

https://dev.folio.org/guidelines/contributing/#apiinterface-versions

https://dev.folio.org/guidelines/naming-conventions/#interfaces

Implementation version numbers (when and how should implementation versions change)

https://dev.folio.org/guidelines/contributing/#version-numbers

https://dev.folio.org/guidelines/contributing/#implementation-versions

API standards and conventions (e.g. endpoint paths and naming, JSON schema naming, structure etc)

https://dev.folio.org/guidelines/contributing/#naming-conventions

https://dev.folio.org/guidelines/naming-conventions/
which also has conventions for interface names, module names, permissions

Release numbers and release branch names

https://dev.folio.org/guidelines/naming-conventions/#release-branches-and-tags
which also links to further information for front-end and back-end "release procedures"

https://dev.folio.org/guidelines/release-procedures/#prepare-and-perform-the-source-release
also discusses "the release tag/version, the next post-release SNAPSHOT version"

Comment by Marc Johnson [ 08/May/20 ]

David Crossley Thank you for doing this (I know it was ages ago :-/ )

I've had this on my to-do list for ages, and I'm not managing to get around to it, but wanted to say thank you anyway.

Generated at Thu Feb 08 23:19:10 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.