ome / ome/ngff

Document the discussion wrap-refresh process

Open
#461 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation infra
Dominant language
Python
Stars
171
Forks
75
Avg merge
2d 3h
Merged PRs (30d)
20

Description

Many PRs and issues around here contain valuable discussions that may drive the future of the NGFF spec.

However, they often get stale, as they depended on something to get done. Some get forgotten, some get transformed and some keep very relevant through time.

It would be good to have a process for wrapping an old, staled discussion and re-writing it as a new Issue, perhaps with a linked PR.

It could be called a wrap-refresh process, with some structure on how to do it in a sensible manner.

User stories

As someone triaging tickets on NGFF...

  • I would like to be able to determine if an issue/PR is still relevant and should be actively tracked.
  • I would like that closed discussions that have value (https://github.com/ome/ngff/pull/64) are superseded by actionable issues

As a new-ish contributor to NGFF...

  • I would like to see summaries of open ideas/issues/discussions without having to dive head-first in lengthy discussions

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the discussion patterns described in this issue and the closed discussion in https://github.com/ome/ngff/pull/64. Define a documented wrap-refresh process for assessing stale issues and PRs, summarizing valuable discussions, and creating actionable superseding issues. Done means the process is clear enough for triagers and new contributors to follow.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.