jimp-dev/jimp

Documentation lacks info about EXIF handling

Open

#991 opened on Mar 3, 2021

View on GitHub
 (0 comments) (2 reactions) (0 assignees)JavaScript (785 forks)batch import
documentationhelp wanted

Repository metrics

Stars
 (13,218 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Expected Behavior

Documentation includes EXIF handling:

  • how can EXIF be accessed
  • how to PRESERVE or copy EXIF to.clone() instance
  • how to add new EXIF data, if no EXIF was set / is in the image
  • how to manipulate existing EXIF data
  • how to EXIF-Auto-Rotate (I believe I read somewhere about this)
  • is anyhing besides EXIF supported?

Current Behavior

Documentatin is missing info about EXIF.

Failure Information (for bugs)

none.

Steps to Reproduce

Read the readme.md

Context

  • Jimp Version: 0.16.1
  • Operating System: OSX /Win latest
  • Node version: 15.11.0

Failure Logs

none.

Contributor guide

Research direction
Explore the Jimp source code and API to document EXIF handling: how to access, preserve, manipulate, and auto rotate using EXIF data. Review existing tests and examples.
Tech stack
javascriptnodejs
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75