Hyrax Maintenance Working Group

Scope & Objectives

The Hyrax Maintenance Working Group (HMWG) is charged with supporting core maintenance and development for Hyrax in order to provide a stable base of support for the solution bundle. Work includes addressing bugs and other issues as they arise and reviewing pull requests to Hyrax. This working group is not meant to be a replacement for community-led development efforts and/or contributions, but rather, it is meant to augment such efforts and release community members who are not part of the working group from the responsibilities around maintenance of Hyrax. 

Roles for Core Team

1 Product Owner: Refines backlog, prioritizes stories and creates milestones, consults with Hyrax Interest Group as needed.

1 Projects Lead: Serves as Scrum Master for sprints.

4-5 Developers: Includes Hyrax Technical Lead, who is responsible for delivering releases in a timely fashion; Developer with UX skills when needed. All will be responsible for communication with Components Maintenance WG as needed.

1-2 Quality Assurance (QA) Specialists/Coordinators: Testing issue backlog and brought in during release time to test or coordinate testing and documentation.

All code contributors must have an Individual Contributor License Agreement (iCLA) on file with the Samvera Steering Group. If the contributor works for an institution, the institution must have a Corporate Contributor License Agreement (cCLA) on file. See Samvera Community Intellectual Property Licensing and Ownership for more information.

Deliverables & Timeframe

The Hyrax Maintenance Working Group responds to an ongoing need for core maintenance and development of Hyrax. It does not have pre-determined deliverables as such. Deliverables include: regular updates when requested at Samvera conferences, partner meetings, etc.; and creation of charters to renew the WG as necessary.

Sprints will continue on the schedule of 2 weeks on and 2 weeks off.  This schedule is not adjusted around holidays and vacations to keep scheduling simple.

Meeting Times & Communication Channels

• The call for participation will be sent to samvera-partners@googlegroups.com, samvera-community@googlegroups.com, and samvera-tech@googlegroups.com, as well as through appropriate slack channels.

• Regular meetings (for sprint planning, stand-ups, etc.) will be held remotely, and will be scheduled at a time and frequency that works best for WG members.

• WG notes and activity, including working drafts of Release Notes, will be documented on the Hyrax Maintenance Working Group wiki page.

Current Year Teams

January - April 2022

Joining a sprint or work cycle

All code contributors must have an Individual Contributor License Agreement (iCLA) on file with the Samvera Steering Group. If the contributor works for an institution, the institution must have a Corporate Contributor License Agreement (cCLA) on file. See Samvera Community Intellectual Property Licensing and Ownership for more information.

Sprints occur on a 2 weeks on and 2 weeks off cycle, regardless of calendar, holidays, or planned time off.
Use the #hyrax-wg channel on Slack to communicate with other HMWG members. You can check in Slack to find out when the next sprint is scheduled to begin.
During a 2 week sprint, daily stand-up occurs via Zoom at 1pm Eastern each weekday of the 2 week sprint (Monday-Friday). Zoom connection info is pinned in the #hyrax-wg Slack channel.
There is a project board in Github that tracks the issues for a sprint and/or work cycle. The current project board is also pinned in the #hyrax-wg Slack channel but should be identifiable by name at https://github.com/samvera/hyrax/projects .

Preparing for HMWG sprint work

Hyrax code is managed in Samvera's Hyrax git repo on Github. Fork that repository and however you prefer, clone that code for working locally (command line checkout, Github Desktop, download a zip).
Make sure Docker is installed locally to contain and manage a local build for running a local Hyrax application.
The following instructions guide you through installing a Hyrax application using Docker: https://github.com/samvera/hyrax/blob/main/CONTAINERS.md

The recommended way to conduct sprint work is to run a Hyrax-based application locally to work on open issues using branches in git. See How to Contribute for details on community contributions for Hyrax (2021-10-20 note: the steps are good but terminology is out-of-date). The essential steps are:

• Fork the repository on Github

• Clone that code for local work

• Create a branch with the issue number in the branch name

• Commit changes to that branch using issue numbers in commit messages

• Run tests and document your changes

• Push that branch up to your forked repository

• Submit a Pull Request (PR) for review and merging to Hyrax repo main branch