Allow filtering of API diffs

Open
#45 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
30/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
java
Domain
api

Research direction

Start at the linked JDK 17 API diff page and inspect how modification types such as "Added" are presented and selected. Trace the page's existing filtering or comparison entry points, then verify that users can hide Added changes or filter by modification type and that the remaining diff is displayed correctly.

Written by the indexing model from the issue text.

Description

enhancement

Hello, I would like to propose the following improvement on this page:
A filter mechanism to filter out "Added" modifications (or just filter based on modification types)
When planning to do an upgrade it's more important to know what will break than know what new API features there are.

Dominant language
HTML
Stars
1.1k
Forks
78
Avg merge
4d 6h
Merged PRs (30d)
5

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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 marchof/java-almanac

All issues in marchof/java-almanac

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.