marchof / marchof/java-almanac
Allow filtering of API diffs
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1.1k
- Forks
- 78
- Avg merge
- 3h 53m
- Merged PRs (30d)
- 7
Description
Hello, I would like to propose the following improvement on [this page](https://javaalmanac.io/jdk/17/apidiff/8/):
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- java
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100