Accession review: aybee reader

オープン
#2 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
javascript

調査の方向性

Start by reading the repository entry point and README, then check whether RERUM or TPEN documentation, the org site, or published exhibits link to the project. Try a clean clone for up to 30 minutes and inspect dependencies for advisories or runtimes that are no longer supported; record blockers rather than fixing them. Finish with the requested status line, health check, live surface and dependency findings, and exactly one recommendation: reactivate, archive, absorb, or leave.

索引モデルが issue の本文から書いたものです。

説明

task

Dormant since 2023-05. Created 2020-10-22, last pushed 2023-05-26. JavaScript, HTML, CSS. Zero open issues. No description on the repo at all.

The name is a phonetic spelling of ABI, which suggests an annotation or IIIF reader. Confirm that before assuming it.

Specific things to check

  • What it actually does. With no description and no open issues, the repo is undocumented to itself. Read the entry point and write a paragraph.
  • Whether it overlaps illuminator or the TPEN interfaces
  • Whether any RERUM or TPEN documentation links to it

What to produce

  1. Status line. One sentence: what this was for, and whether that purpose still exists.
  2. Health check. Does it run from a clean clone today? Timebox this to 30 minutes. If it does not run, record the blocker rather than fixing it.
  3. Live surface. Is anything from this repo still deployed or linked from a live page? Check the org site, the RERUM and TPEN docs, and any published exhibits. A dead URL that other people's pages still point at is a real problem.
  4. Dependency audit. Anything with a known advisory, anything pinned to a runtime that no longer ships.
  5. One call. Pick exactly one:
    • reactivate - worth working on again, and there is a reason
    • archive - historically useful, no future. Archive the repo and write the README eulogy.
    • absorb - the useful part belongs somewhere else. Name the destination and what moves.
    • leave - no decision needed now, revisit next year. Say so and close this issue.

Why bother

Filed from cubap/DriftMD#4. Low priority by design. These are free-cycle tasks, and the point of writing them down is that a future pass has somewhere to start instead of re-deriving everything from a git log.

主要言語
JavaScript
スター
0
フォーク
0
平均マージ
2日 21時間
マージ済み PR(30日)
1

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

CenterForDigitalHumanities/aybee のほかの issue

CenterForDigitalHumanities/aybee の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。