From e4fac7264811e0e0b19e34dcefd0c4565b495653 Mon Sep 17 00:00:00 2001 From: Guilherme Carvalho Date: Wed, 4 Mar 2026 16:19:44 -0300 Subject: [PATCH 1/5] chore: refactor pull request template for better structure and guidance - Clearly separate UI (frontend) and API (backend) sections - Add before/after screenshot table for UI changes - Include checklists for tasks, testing, documentation, accessibility, etc. - Preserve Codespaces testing instructions in a collapsible block - Add visual hints (ASCII art comments) to guide removal of irrelevant sections - Update API documentation instruction to use `composer openapi` - Add optional items: browser testing, accessibility, design review, capabilities - Include AI disclosure checkbox for transparency This addresses the requirements of issue #5534 and incorporates feedback from the previous attempt (#6200). Fixes #5534 Signed-off-by: Guilherme Carvalho --- .github/pull_request_template.md | 127 ++++++++++++++++++------------- 1 file changed, 72 insertions(+), 55 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 43d5946d7c..bf12022c3d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,66 +1,83 @@ -### Pull Request Description + + +* Resolves: # + +## Summary + +A concise description of what this PR does and why. + +## How to test + +
+Instructions for running the app in Codespaces or local development + +1. Open a Codespace using the `LibreSign` repository or start the container with `make dev-setup`. +2. Build assets (`npm run watch` for frontend, `composer test:unit -- --filter ...` for backend). +3. Execute the steps required to reproduce the changes (e.g. upload a PDF, open validation screen, call API endpoint). +4. Verify that the behaviour matches the description above. + +Feel free to paste terminal commands or URLs that help reviewers follow along. + +
+## UI / Frontโ€‘end changes -### Related Issue -Issue Number: -### Pull Request Type +- [ ] ... +- [ ] Screenshots before/after (add images or links) + +| Before | After | +| --- | --- | +| + +- [ ] Tested in multiple browsers (Chrome, Firefox, Safari) โ€“ *optional but appreciated* +- [ ] Accessibility verified (contrast, keyboard navigation, screen reader friendly) โ€“ *if applicable* +- [ ] Design review approved โ€“ *optional, link to feedback if available* +- [ ] User documentation updated (if applicable) โ€“ [user manual](https://docs.libresign.coop/user_manual/) / [docs repository](https://github.com/LibreSign/documentation/) + +## API / Backโ€‘end changes -### Pull request checklist +- [ ] ... +- [ ] Unit and/or integration tests added โ€“ *required for backend changes* +- [ ] Capabilities updated (if applicable) โ€“ if adding/modifying Nextcloud capabilities +- [ ] API documentation updated with the command `composer openapi` if necessary -- [ ] Did you explain or provide a way of how can we test your code ? -- [ ] If your pull request is related to frontend modifications provide a print of before and after screen -- [ ] Did you provide a general summary of your changes ? -- [ ] Try to limit your pull request to one type, submit multiple pull requests if needed -- [ ] I implemented tests that cover my contribution +## โœ… Checklist -
-How to see this running using GitHub Codespaces - -### 1. Open the Codespace -- Authenticate to GitHub -- Go to the branch: [chore/reduce-configure-check-time](https://github.com/LibreSign/libresign/tree/chore/reduce-configure-check-time) -- Click the `Code` button and select the `Codespaces` tab. -- Click **"Create codespace on feat/customize-signature-stamp"** - -### 2. Wait for the environment to start -- A progress bar will appear on the left. -- After that, the terminal will show the build process. -- Wait until you see the message: - ```bash - โœ๏ธ LibreSign is up! - ``` - This may take a few minutes. - -### 3. Access LibreSign in the browser -- Open the **Ports** tab (next to the **Terminal**). -- Look for the service running on port **80**. -- Hover over the URL and click the **globe icon** ๐ŸŒ to open it in your browser. - -### 4. (Optional) Make the service public -- If you want to share the app with people **not logged in to GitHub**, you must change the port visibility: - - Click the three dots `โ‹ฎ` on the row for port 80. - - Select `Change visibility` โ†’ `Public`. - -### 5. Login credentials -- **Username**: `admin` -- **Password**: `admin` - -Done! ๐ŸŽ‰ -You're now ready to test this. -
+- [ ] I have read and followed the [contribution guide](CONTRIBUTING.md). +- [ ] ... (list your own tasks here) + +## AI (if applicable) + +- [ ] The content of this PR was partially or fully generated using AI From 61bd808ab7753c57d777ffc5d3ef4231a58c8592 Mon Sep 17 00:00:00 2001 From: Guilherme Carvalho Date: Wed, 4 Mar 2026 23:32:33 -0300 Subject: [PATCH 2/5] chore: refactor pull request template incorporating review suggestions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add before/after screenshot table with emoji headers for UI changes - Add frontend testing requirements (vitest, Playwright) - Add customizable "๐Ÿšง Tasks" block for pre-merge tasks in UI and API sections - Remove HackerOne security notice (not used) - Simplify table syntax and remove Nextcloud-specific mentions - Consolidate documentation references to a single docs repository link - Preserve Codespaces testing instructions in a collapsible block This incorporates all suggestions from the review process. Fixes #5534 Signed-off-by: Guilherme Carvalho --- .github/pull_request_template.md | 70 ++++++++++++++++++++++---------- 1 file changed, 49 insertions(+), 21 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index bf12022c3d..5793b230e1 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,10 +1,4 @@ - - -* Resolves: # +Resolves: # ## Summary @@ -13,15 +7,39 @@ A concise description of what this PR does and why. ## How to test
-Instructions for running the app in Codespaces or local development - -1. Open a Codespace using the `LibreSign` repository or start the container with `make dev-setup`. -2. Build assets (`npm run watch` for frontend, `composer test:unit -- --filter ...` for backend). -3. Execute the steps required to reproduce the changes (e.g. upload a PDF, open validation screen, call API endpoint). -4. Verify that the behaviour matches the description above. - -Feel free to paste terminal commands or URLs that help reviewers follow along. - +How to see this running using GitHub Codespaces + +### 1. Open the Codespace +- Authenticate to GitHub +- Go to the branch: [chore/reduce-configure-check-time](https://github.com/LibreSign/libresign/tree/chore/reduce-configure-check-time) +- Click the `Code` button and select the `Codespaces` tab. +- Click **"Create codespace on feat/customize-signature-stamp"** + +### 2. Wait for the environment to start +- A progress bar will appear on the left. +- After that, the terminal will show the build process. +- Wait until you see the message: + ```bash + โœ๏ธ LibreSign is up! + ``` + This may take a few minutes. + +### 3. Access LibreSign in the browser +- Open the **Ports** tab (next to the **Terminal**). +- Look for the service running on port **80**. +- Hover over the URL and click the **globe icon** ๐ŸŒ to open it in your browser. + +### 4. (Optional) Make the service public +- If you want to share the app with people **not logged in to GitHub**, you must change the port visibility: + - Click the three dots `โ‹ฎ` on the row for port 80. + - Select `Change visibility` โ†’ `Public`. + +### 5. Login credentials +- **Username**: `admin` +- **Password**: `admin` + +Done! ๐ŸŽ‰ +You're now ready to test this.
## UI / Frontโ€‘end changes @@ -42,16 +60,21 @@ Feel free to remove this section when your PR only affects the backend/API code. - [ ] ... - [ ] Screenshots before/after (add images or links) -| Before | After | -| --- | --- | -| +- [ ] ... - +๐Ÿš๏ธ Before | ๐Ÿก After +--- | --- + | + + - [ ] Tested in multiple browsers (Chrome, Firefox, Safari) โ€“ *optional but appreciated* +- [ ] Components, Unit (with vitest) and/or e2e (with Playwright) tests added - *Required* - [ ] Accessibility verified (contrast, keyboard navigation, screen reader friendly) โ€“ *if applicable* - [ ] Design review approved โ€“ *optional, link to feedback if available* -- [ ] User documentation updated (if applicable) โ€“ [user manual](https://docs.libresign.coop/user_manual/) / [docs repository](https://github.com/LibreSign/documentation/) +- [ ] Documentation updated (if applicable) โ€“ [docs repository](https://github.com/LibreSign/documentation/) ## API / Backโ€‘end changes @@ -71,8 +94,13 @@ Feel free to remove this section when your PR only affects the frontend/UI code. - [ ] ... - [ ] Unit and/or integration tests added โ€“ *required for backend changes* - [ ] Capabilities updated (if applicable) โ€“ if adding/modifying Nextcloud capabilities +- [ ] Documentation updated (if applicable) - [docs repository](https://github.com/LibreSign/documentation) - [ ] API documentation updated with the command `composer openapi` if necessary +### ๐Ÿšง Tasks + +- [ ] ... + ## โœ… Checklist - [ ] I have read and followed the [contribution guide](CONTRIBUTING.md). From dbb3608ab6fe42a7f075dd760e7a3c5d3e3910cf Mon Sep 17 00:00:00 2001 From: Guilherme Carvalho Date: Wed, 4 Mar 2026 23:38:11 -0300 Subject: [PATCH 3/5] chore: add friendly emojis to pull request template sections Improve visual guidance and consistency by adding emojis to main titles Fixes #5534 Signed-off-by: Guilherme Carvalho --- .github/pull_request_template.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 5793b230e1..1604ada7c3 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,10 +1,10 @@ Resolves: # -## Summary +## ๐Ÿ“ Summary A concise description of what this PR does and why. -## How to test +## ๐Ÿงช How to test
How to see this running using GitHub Codespaces @@ -42,7 +42,7 @@ Done! ๐ŸŽ‰ You're now ready to test this.
-## UI / Frontโ€‘end changes +## ๐ŸŽจ UI / Frontโ€‘end changes | + @@ -76,7 +76,7 @@ Feel free to remove this section when your PR only affects the backend/API code. - [ ] Design review approved โ€“ *optional, link to feedback if available* - [ ] Documentation updated (if applicable) โ€“ [docs repository](https://github.com/LibreSign/documentation/) -## API / Backโ€‘end changes +## โš™๏ธ API / Backโ€‘end changes A concise description of what this PR does and why. ## ๐Ÿงช How to test +
How to see this running using GitHub Codespaces From cd8e67e2351d7fc9fe61ff6ecc13a18a53cb3db0 Mon Sep 17 00:00:00 2001 From: Vitor Mattos Date: Thu, 5 Mar 2026 00:12:42 -0300 Subject: [PATCH 5/5] Update .github/pull_request_template.md Signed-off-by: Vitor Mattos --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d84c0d6a64..ad091c2c0a 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -79,7 +79,7 @@ Feel free to remove this section when your PR only affects the backend/API code. ๐Ÿš๏ธ Before | ๐Ÿก After --- | --- - +Screenshot before | Screenshot after