Home

Introduction to the OCFL Use Cases

This repository is for collecting, discussing, and deciding on the use cases for the Oxford Common File Layout initiative. As such, most activity happens over in the "Issues" tab.

Currently, only members of the editorial team have the ability to 'triage' issues and apply labels.

What do these labels mean?

In the issues list you will see a number of labels. These labels help track the workflow for an issue, to ensure it has received proper discussion and a thorough hearing.

Status labels

All new issues start with the Proposed: In-Scope tag. This signifies that an issue contains a proposed use case. From there, issues can go to:

• Confirmed: In-Scope (if the discussion and editorial team decides it is confirmed)
• Proposed: Out-of-scope (if the discussion seems to suggest that it might be out-of-scope, or an editorial team member wishes to propose that it is out of scope, accompanied by a suitable explanation of why they think so)

Confirmed: Out-of-scope is, effectively, a 'close this issue' status. It should only be closed if a second editorial team member confirms that an issue is out of scope.

Needs Clarification is reserved for issues for which there are too few details in the original post on which to base a decision.

Component labels

Some issues may, if it is clear, receive a 'Component' label. This label can be applied to help guide the editorial team into figuring out if an issue pertains to the core specification (Component: Specification), to client behaviours (Component: Client Behaviors) -- typically involving read/write operations --, or object validation (Component: Validation).