Perform Release Review

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

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
javascript, markdown

Research direction

Start by reviewing the changes from v0.0.6..main, then check tests, lint, documentation, accessibility, and correctness against the listed criteria. File and prioritize findings, revisit milestone dates, and finish by tagging v0.0.7 and publishing release notes; the issue does not name specific files or tests to begin with.

Written by the indexing model from the issue text.

Description

review

The last task in this milestone: a look back over what it changed, before it's tagged.

Review v0.0.6..main for:

  • Technical debt: duplication, dead code, things worked around rather than fixed
  • Quality: tests missing for what changed, lint, naming, docs and the README
  • Correctness: reproduce anything suspicious; file:line as of the review's commit
  • Accessibility: axe, the accessibility tree and a keyboard trace of what's new (WCAG 2.2 AA)

Then:

  • File each finding as an issue (or a checklist in one issue per area), prioritized into an upcoming milestone; open a new milestone if none fits
  • Keep security findings out of GitHub: they go in .issues/, with a vague line in priorities.md
  • Write up a report: each finding, the milestone it went to and why, and what looked like a finding but was set aside, and why
  • Revisit the dates of the milestones that follow; if we're ahead, pull work or polishes forward
Dominant language
JavaScript
Stars
0
Forks
1
Avg merge
2d 4h
Merged PRs (30d)
26

Getting set up

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.

More from jzheaux/reader

All issues in jzheaux/reader

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.