From a9e662e612789abd798c173cd6f17bd1bdd09aff Mon Sep 17 00:00:00 2001 From: Lovell Fuller Date: Thu, 25 Apr 2024 11:25:12 +0100 Subject: [PATCH] Issue template: add a couple of the most commonly-reported problems This should allow more people to help themselves and prevent extraneous issues from being opened. --- .github/ISSUE_TEMPLATE/possible-bug.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/possible-bug.md b/.github/ISSUE_TEMPLATE/possible-bug.md index c74c87ee8..3d05f2244 100644 --- a/.github/ISSUE_TEMPLATE/possible-bug.md +++ b/.github/ISSUE_TEMPLATE/possible-bug.md @@ -32,6 +32,22 @@ If you are using another package which depends on a version of `sharp` that is n +### Does this problem relate to file caching? + +The default behaviour of libvips is to cache input files, which can lead to `EBUSY` or `EPERM` errors on Windows. +Use `[sharp.cache(false)](https://sharp.pixelplumbing.com/api-utility#cache)` to switch this feature off. + +- [ ] Adding `sharp.cache(false)` does not fix this problem. + +### Does this problem relate to images appearing to have been rotated by 90 degrees? + +Images that contain EXIF Orientation metadata are not auto-oriented. By default, EXIF metadata is removed. + +- To auto-orient pixel values use the parameter-less `[rotate()](https://sharp.pixelplumbing.com/api-operation#rotate)` operation. +- To retain EXIF Orientation use `[keepExif()](https://sharp.pixelplumbing.com/api-output#keepexif)`. + +- [ ] Using `rotate()` or `keepExif()` does not fix this problem. + ### What are the steps to reproduce?