Skip to content

Latest commit

 

History

History
36 lines (21 loc) · 3.72 KB

curation.md

File metadata and controls

36 lines (21 loc) · 3.72 KB

Awesome IIIF Curation Guidelines

Curators of Awesome

Maintaining a useful and organized awesome list takes work. New resources need to be discovered and evaluated. The Awesome IIIF list is curated by active members in the IIIF community. In order to get involved, join the #curators_of_awesome channel in Slack and let us know you'd like to help. We use the channel to organize our efforts and discuss how to improve the list.

Process

List items begin as pull requests or issues. In order for an item to be added to the list, an issue must be submitted containing at minimum a link to the item, along with a description and rationale for why the item should be added to the list. Details of expectations for pull requests can be found in the Contributing Guidelines. Anyone in the community can issue a pull request or submit an issue with a new item. The job of curators is to determine what to approve and whether it meets the standards for our list.

Assessment

The Awesome IIIF list is a curated repository of exemplar IIIF resources, such as helpful links to material about each of the IIIF APIs, demonstrations of their use, tutorials, and presentations. When assessing resources for “awesomeness,” curators consider the following kinds of questions.

  • Does the resource provide an exceptional working example of one or more IIIF APIs in action? Is it high quality? Original? A demonstration of new functionality?
  • Is the resource widely useful or does it provide reusable tools?
  • Does the resource provide good guidance for implementing IIIF APIs?
  • Does the resource provide a clear explanation of one or more of the IIIF APIs for newcomers?
  • If the resource is a written work, such as an article, blog, or scholarly work, does it provide a clear message about the benefits of IIIF or provoke ideas about future applications and experimentation?
  • Does the resource add depth or more choice to a particular section of the Awesome list?

Before Approval

Visit the link to the resource and evaluate whether it is appropriate for our awesome list. Make sure any pull requests follow the contribution guidelines for adding to the list. For instance, read the short description to make sure it is clear, concise, and accurate. An issue or pull request ought to have an appropriate description added before it is approved.

Approvals

All new items ought to have the approval of 2 Curators of Awesome before being merged or added. Approval can be signaled with a thumbs up from any curator. Any approvals ought to come from someone else other than the submitter or someone associated with the item. Bug fixes like broken links can be made immediately by anyone with commit rights.

Sections

If you see the need to add a new section or rearrange items into different sections, follow the same process as for items. Issue a pull request or detail in an issue what change you would like to make for discussion and approval. It is best for a new section to start with at least two items.

Weeding

One of the goals of the list is to be current for the best practices and tools available. Resources can go out of date and do a disservice to the community to continue to list them. Over time some links will no longer resolve, a demo will no longer be functional, or a tool superseded. Periodically curators will review the links currently on the list and consider if any ought to be removed. The same approval process for additions will be used for removals. In-person conference (Spring) and working group (Fall) meetings will be opportunities to review the list for curation and weeding.