[FOLIO-2207] publish PR reviews checklists on dev.folio.org Created: 07/Aug/19  Updated: 08/Jan/21  Resolved: 16/Aug/19

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

Type: Task Priority: P3
Reporter: Jakub Skoczen 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-2214 New dev.folio.org docs regarding the ... Closed
Sprint: CP: sprint 70
Story Points: 2
Development Team: Core: Platform

 Description   

The section called "Pull Request checklists" from https://docs.google.com/document/d/10cTOkUBpi7myIBQfrvdLGihLE1Wes3rRxFgDZs-Is64/edit

should be published on dev.folio.org and added as a new section (or linked to) to https://dev.folio.org/guidelines/contributing/

David Crossley Marc Johnson



 Comments   
Comment by Marc Johnson [ 13/Aug/19 ]

Jakub Skoczen David Crossley I think the check lists don't necessarily make sense without the context from the Pull Request Code Review section.

I'd also like that section publishing so that we can formally communicate these expectations / policies to the developer community (and folks can stop rely on me specifically for permission to merge).

This likely means we also need to include the Code Owners section.

David Crossley Please ping me or comment here if any of this does not make sense.

Comment by David Crossley [ 13/Aug/19 ]

Thanks, i have been wondering how to structure this document (or documents). Nothing is ever easy.

Comment by Marc Johnson [ 13/Aug/19 ]

David Crossley Jakub Skoczen

Thanks, i have been wondering how to structure this document (or documents). Nothing is ever easy.

Indeed information architecture is difficult.

I think there are likely to be a lot of other documentation coming in this area.

My thoughts are that was need some areas something like this:

  • Development process
  • Development roles
  • Guidance (I think there is already a section called guides so that might already represent this)
  • Checklists
Comment by Jakub Skoczen [ 14/Aug/19 ]

Please publish also the following section:

  • we expect a 48hrs SLA for PR reviews
  • if 48hrs pass and no reviewers agreed to review the PR, tag the CODEOWNERS group on the PR (in the comment) again to ping people again
  • and post a message to #pullrequests channel to nudge reviewers into reviewing them
  • the process for accepting responsibility for a review is as follows: once reviewer agrees to review the PR he/she assigns him/herself as the Assignee (next to the already existing Assignee who represents the author of the PR), There can be more than one reviewer hence more than one Assignee
Comment by Marc Johnson [ 14/Aug/19 ]

Jakub Skoczen David Crossley I've updated the development process to include the information that @jakub mentioned above

Comment by David Crossley [ 14/Aug/19 ]

I have the "Pull Requests Checklists" ready to publish as its own separate document (the topic of this ticket).

The "Development Roles" and "Development Process" should also be separate documents. They should be done soon as separate tickets, otherwise they are just going to hold up this FOLIO-2207 Closed . Those documents still have "outstanding decisions".

Comment by Marc Johnson [ 14/Aug/19 ]

I have the "Pull Requests Checklists" ready to publish as its own separate document (the topic of this ticket).

Thanks

The "Development Roles" and "Development Process" should also be separate documents. They should be done soon as separate tickets, otherwise they are just going to hold up this FOLIO-2207 Closed .

I think that without them, the checklists have limited value due to a lack of context, however I'm happy for them to be published separately if it helps with the work.

Jakub Skoczen What do you think, do we need separate tickets? If so, would you like me to raise them or you?

Those documents still have "outstanding decisions".

I don't think this should stop them being published. It is likely these documents will go through numerous iterations.

These sections should be omitted from the published versions (although I don't mind if they are included).

Comment by David Crossley [ 15/Aug/19 ]

This new document is at https://dev.folio.org/guidelines/pull-requests-checklists/

Also linked from the existing PR-related sections of "Guidelines for Contributing Code":
https://dev.folio.org/guidelines/contributing/#requesting-a-merge
and raised the prominence of those sections.

Will focus next on the other related documents.

Comment by Marc Johnson [ 15/Aug/19 ]

David Crossley Thanks, those look great. Thank you for adding in the extra links to tools, existing guidance etc

Comment by David Crossley [ 16/Aug/19 ]

See FOLIO-2214 Closed for the further related documents.

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