2022-05-19 DSpace 7 Working Group Meeting

Date

19 May 2022 from 14:00-15:00 UTC

Location: https://lyrasis.zoom.us/my/dspace (Meeting ID: 502 527 3040).  Passcode: dspace

• More connection options available at DSpace Meeting Room

Agenda

• (30 mins) General Discussion Topics
  1. (10 mins) Updated proposed schedule above. After initial review, we have 3 weeks until PR Merger Deadline (June 10). 
  2. Other topics?
  3. (Notes for post-7.3) 7.4 Planning discussion
     1. Based on feedback from last week, we will likely want to rethink our planning strategies for the 7.4 release.  In 7.3, we've noticed the same pattern of too few reviews prior to the Review Deadline and too many PRs getting created at the last minute (just before PR creation deadline).  Some brainstorms follow
     2. During 7.4 planning, we may want to set earlier deadlines for large features.  Existing model works best for small features / bug fixes.
        1. Large features should be broken down into stages / steps.  Schedule an earlier PR deadline(s) for those steps.  Also schedule review deadlines for those steps
        2. Goal is to ensure Large features being implementation earlier & get feedback earlier.  If they can be broken down into stages/steps, then the final PR & review will be much easier.
• (30 mins) Planning for next week
  • Review the Backlog Board - Are there any tickets here stuck in the "Triage" column?  We'd like to keep this column as small as possible.
  • Review the 7.3 Project Board - Assign tickets to developers & assign PRs to reviewers.
    • Paid (by DSpace project) developers must keep in mind priority. If new "high" or "medium" priority tickets come in, developers should move effort off of "low" priority tasks.
    • Volunteer developers are allowed to work on tickets regardless of priority, but ideally will review code in priority order.

Attendees

• Art Lowel (Atmire) 

• Andrea Bollini (4Science)

• Tim Donohue

• Lieven Droogmans

• Giuseppe Digilio (4Science)
• Ben Bosman
• Paulo Graça
• Mark H. Wood 
• Pascal-Nicolas Becker 

Current Work

Project Board

DSpace 7.3 Project Board: https://github.com/orgs/DSpace/projects/16

To quickly find PRs assigned to you for review, visit https://github.com/pulls/review-requested  (This is also available in the GitHub header under "Pull Requests → Review Requests")

New Feature development process for 7.3

• For brand new UI features, at a minimum, the UI ticket should contain a description of how the feature will be implemented
  • If the UI feature involves entirely new User Interface interactions or components, we recommend mockups or links to examples elsewhere on the web.  (If it's useful, you can create a Wiki page and use the Balsamiq wireframes plugin in our wiki)
  • Feature design should be made publicly known (i.e. in a meeting) to other Developers. Comments/suggestions must be accepted for TWO WEEKS, or until consensus is achieved (whichever comes first).  After that, silence is assumed to be consent to move forward with development as designed.  (The team may decide to extend this two week deadline on a case by case basis, but only before the two week period has passed. After two weeks, the design will move forward as-is.)
  • This does mean that if a UI feature is later found to have design/usability flaws, those flaws will need to be noted in a bug ticket (to ensure we don't repeat them in other features) and fixed in follow-up work.
• For brand new REST features (i.e. new endpoints or major changes to endpoints), at a minimum we need a REST Contract prior to development.
  • REST Contract should be made publicly known (i.e. in a meeting) to other Developers.  Comments/suggestions must be accepted for TWO WEEKS, or until consensus is achieved (whichever comes first). After that, silence is assumed to be consent to move forward with development. (The team may decide to extend this two week deadline on a case by case basis, but only before the two week period has passed. After two weeks, the design will move forward as-is.)
  • This does mean that some REST features may need future improvement if the initial design is found to later have RESTful design flaws.  Such flaws will need to be noted in a bug ticket (to ensure we don't repeat them in other features) and fixed in follow-up work.
  • REST API Backwards Compatibility support
    • During 7.x development, we REQUIRE backwards compatibility in the REST API layer between any sequential 7.x releases.  This means that the 7.1 REST API must be backwards compatible with 7.0, and 7.2 must be compatible with 7.1, etc.
      • However, deprecation of endpoints is allowed, and multi-step 7.x releases may involve breaking changes (but those breaking changes must be deprecated first & documented in Release Notes).  This means that it's allowable for the 7.2 release to have changes which are incompatible with the 7.0 release, provided they were first deprecated in 7.1.   Similarly, 7.3 might have breaking changes from either 7.1 or 7.0, provided they were deprecated first.
    • After 7.x development, no breaking changes are allowed in minor releases. They can only appear in major releases (e.g. 7.x→8.0 or 8.x→9.0 may include breaking changes).

Issue Triage process for 7.3

• Overview of our Triage process:
  1. Initial Analysis:  Tim Donohue will do a quick analysis of all issue tickets coming into our Backlog Board (this is where newly reported issues will automatically appear).
  2. Prioritization/Assignment: If the ticket should be considered for this release, Tim Donohue will categorize/label it (high/medium/low priority) and immediately assign to a developer to further analysis. Assignment will be based on who worked on that feature in the past.
     1. "high priority" label = A feature is badly broken or missing/not working. These tickets must be implemented first, as ideally they should be resolved in the next release.  (Keep in mind however that priorities may change as the release date approaches. So, it is possible that a "high priority" ticket may be rescheduled if it is a new feature that cannot fit into release timelines.)
     2. "medium priority" label = A feature is difficult to use, but mostly works.. These tickets might be resolved prior to the next release (but the release will not be delayed to fix these issues).
     3. "low priority" label = A feature has usability issues or other smaller inconveniences or a non-required feature is not working as expected.  These tickets are simply "nice to have" in the next release.  We'll attempt to fix them as time allows, but no guarantees are made.
  3. Detailed Analysis: Developers should immediately analyze assigned tickets and respond back within 1-2 days. The developer is expected to respond to Tim Donohue with the following:
     1. Is the bug reproducible?  (If the developer did not understand the bug report they may respond saying they need more information to proceed.)
     2. Does the developer agree with the initial prioritization (high/medium/low), or do they recommend another priority?
     3. Does the bug appear to be on the frontend/UI or backend/REST API?
     4. Does the developer have an idea of how difficult it would be to fix? Either a rough estimate, or feel free to create an immediate PR (if the bug is tiny & you have time to do so).
     5. Are you (or your team) interested in being assigned this work?
  4. Final Analysis: Tim Donohue will look at the feedback from the developer, fix ticket labels & move it to the appropriate work Board.  If it is moved to the Project Board, then the ticket may be immediately assigned back to the developer (if they expressed an interest) to begin working on it.
     1. If the ticket needs more info, Tim Donohue will send it back to the reporter and/or attempt to reproduce the bug himself.  Once more info is provided, it may be sent back to the developer for a new "Detailed Analysis".

Notes