From fc95d42b35cf802e48579acf236115fbd8e8baf0 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 12 Sep 2025 15:51:49 -0700 Subject: [PATCH 1/3] Documentation: add guidance for feature PRs in CONTRIBUTING.md --- CONTRIBUTING.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2f7952ad0..8572b5fd3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,9 +2,14 @@ If you feel like contributing to the project, please do! Bug fixes and improvements are always welcome. +!!! warning + + Pull requests that implement a new feature or enhancement *should almost always target an existing feature request* with evidence of community interest and discussion. This is in order to balance the work of implementing and maintaining new features / enhancements. Pull requests that are opened without meeting + this requirement may not be merged. + If you want to implement something big: -- Please start a discussion about that in the issues! Maybe something similar is already in development and we can make it happen together. +- As above, please start with a discussion! Maybe something similar is already in development and we can make it happen together. - When making additions to the project, consider if the majority of users will benefit from your change. If not, you're probably better of forking the project. - Also consider if your change will get in the way of other users. A good change is a change that enhances the experience of some users who want that change and does not affect users who do not care about the change. - Please see the [paperless-ngx merge process](#merging-prs) below. From 3e4aa87cc5ac337a6e619d01d4398e9a76e6433d Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 12 Sep 2025 15:55:22 -0700 Subject: [PATCH 2/3] Fix formatting --- CONTRIBUTING.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8572b5fd3..24f563c7a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,10 +2,7 @@ If you feel like contributing to the project, please do! Bug fixes and improvements are always welcome. -!!! warning - - Pull requests that implement a new feature or enhancement *should almost always target an existing feature request* with evidence of community interest and discussion. This is in order to balance the work of implementing and maintaining new features / enhancements. Pull requests that are opened without meeting - this requirement may not be merged. +⚠️ Please note: Pull requests that implement a new feature or enhancement _should almost always target an existing feature request_ with evidence of community interest and discussion. This is in order to balance the work of implementing and maintaining new features / enhancements. Pull requests that are opened without meeting this requirement may not be merged. If you want to implement something big: From 43b4f360263ceef6b2c4e8d780a616c2e5742050 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Sun, 21 Sep 2025 16:07:29 -0700 Subject: [PATCH 3/3] Documentation: add note about logo file visibility and exif data --- docs/configuration.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/configuration.md b/docs/configuration.md index fdc0097dd..bb88415ed 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1759,6 +1759,11 @@ started by the container. : Path to an image file in the /media/logo directory, must include 'logo', e.g. `/logo/Atari_logo.svg` +!!! note + + The logo file will be viewable by anyone with access to the Paperless instance login page, + so consider your choice of logo carefully and removing exif data from images before uploading. + #### [`PAPERLESS_ENABLE_UPDATE_CHECK=`](#PAPERLESS_ENABLE_UPDATE_CHECK) {#PAPERLESS_ENABLE_UPDATE_CHECK} !!! note