lovell / lovell/sharp

Docs: include more info and sample images about resize kernels

Open
#3,354 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
32.7k
Forks
1.4k
Avg merge
1d 14h
Merged PRs (30d)
5

Description

@lovell, I've seen several issues where you've answered by suggesting the use of a specific kernel for various use cases, but I don't have a very good understanding of what each one does at a high level.

It would be really great if the documentation provided some rough guidance on the various kernels, explaining briefly what the primary use case is for each, and discussing the tradeoffs involved. I'm thinking really simple, quick bullet points like "The X kernel is fast, but sacrifices quality. It's great for line drawings, but not very well suited for rich photos, etc."

BTW, thanks for this really impressive lib!

Contributor guide

Open the contributing guide

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 locating the existing documentation for resize kernels and reviewing how the kernels are currently described. Add concise guidance on each kernel's primary use case and tradeoffs, along with sample images, so readers can compare the results and choose appropriately.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, nodejs
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.