[FOLIO-2214] New dev.folio.org docs regarding the development and review process Created: 16/Aug/19  Updated: 08/Jan/21  Resolved: 22/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-2951 Refer from dev.f.o to Wiki Pull Reque... Closed
relates to FOLIO-2232 Spike: Gather existing guidelines for... Closed
relates to FOLIO-2207 publish PR reviews checklists on dev.... Closed
Sprint: CP: sprint 70
Story Points: 3
Development Team: Core: Platform

 Description   

The FOLIO-2207 Closed "Pull request checklists" was part-1. The remainder of documentation to support the development and review process now needs to be added.

The gdoc with initial content is linked from FOLIO-2207 Closed .



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

The document is ready. It uses most of the current content from the linked gdoc.

See pull/447 and the generated document in the staging area:
Development, design, and review processes (guidelines/development-design-review)

The "Outstanding decisions" sub-sections are included. They can be revised later, as each is resolved.

Comment by David Crossley [ 22/Aug/19 ]

This new document is published at https://dev.folio.org/guidelines/development-design-review/

Comment by Marc Johnson [ 27/Aug/19 ]

David Crossley Jakub Skoczen Thank you, I finally managed to review these changes on the website and it's all good.

I might have some minor tweaks going forward, but I'll either raise issues and/or pull requests for the dev website. I think the next step is to establish some skeleton guidance pages that can be used for links from the check lists.

Comment by Marc Johnson [ 27/Aug/19 ]

I've found references to the following kinds of guidance:

  • Interface compatibility (when is a change interface breaking)
  • Implementation compatibility (when is a change implementation breaking)
  • Interface version numbers (when and how should interface versions change)
  • Implementation version numbers (when and how should implementation versions change)
  • API standards and conventions (e.g. endpoint paths and naming, JSON schema naming, structure etc)

David Crossley Jakub Skoczen Which of these overlap with existing guidance? Should we refer to that and refine it, or should I just start from scratch and write up separate guidance (and hence create skeleton pages or sections for these)?

Comment by David Crossley [ 29/Aug/19 ]

This FOLIO-2214 Closed is a closed issue which added the initial document.

I have moved this topic to a new ticket: FOLIO-2232 Closed

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