jimp-dev/jimp

Documentation lacks info about EXIF handling

Open

#991 geöffnet am 3. März 2021

Auf GitHub ansehen
 (0 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)JavaScript (13.218 Stars) (785 Forks)batch import
documentationhelp wanted

Beschreibung

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

Tech Stack
javascriptnodejs
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
basic knowledge of EXIF metadatafamiliarity with Jimp API
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85
Research-Richtung
Review the current README.md file at https://github.com/jimp dev/jimp/blob/master/README.md. The issue requests adding documentation for accessing EXIF data, preserving it when cloning images, adding new EXIF data, manipulating existing EXIF, auto rotation, and whether other metadata formats are supported. Look for existing Jimp methods like `exif` or `exifRotate` in the source code (possibly in src/image/exif.js). The documentation should explain how to use these methods with examples. Since the issue is from 2021 and Jimp may have evolved, check the latest version's API to ensure accuracy.