jimp-dev/jimp

Documentation lacks info about EXIF handling

Open

#991 创建于 2021年3月3日

在 GitHub 查看
 (0 评论) (2 反应) (0 负责人)JavaScript (13,218 star) (785 fork)batch import
documentationhelp wanted

描述

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.

贡献者指南

技术栈
javascriptnodejs
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic knowledge of EXIF metadatafamiliarity with Jimp API
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85
研究方向
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.