chore: refactor pull request template for better structure and guidance#7072
Merged
vitormattos merged 5 commits intoLibreSign:mainfrom Mar 5, 2026
Merged
Conversation
- 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 LibreSign#5534 and incorporates feedback from the previous attempt (LibreSign#6200). Fixes LibreSign#5534 Signed-off-by: Guilherme Carvalho <dev.gcarvalho@gmail.com>
|
Thanks for opening your first pull request in this repository! ✌️ |
vitormattos
requested changes
Mar 4, 2026
Member
vitormattos
left a comment
There was a problem hiding this comment.
Nice! Thanks a lot!
Follow some suggestions.
- 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 LibreSign#5534 Signed-off-by: Guilherme Carvalho <dev.gcarvalho@gmail.com>
Improve visual guidance and consistency by adding emojis to main titles Fixes LibreSign#5534 Signed-off-by: Guilherme Carvalho <dev.gcarvalho@gmail.com>
Clarify that the Codespaces block is a fixed template feature, and that contributors must write specific testing steps for each PR. Fixes LibreSign#5534 Signed-off-by: Guilherme Carvalho <dev.gcarvalho@gmail.com>
Contributor
Author
There was a problem hiding this comment.
I included a comment clarifying that the Codespaces block is a permanent part of the template, but that specific testing instructions must be written manually for each PR. This addresses the requirement from issue #5534 to retain the Codespaces instructions while also guiding contributors on how to use the template correctly.
vitormattos
approved these changes
Mar 5, 2026
Signed-off-by: Vitor Mattos <vitor@php.rio>
Member
|
/backport to stable33 |
Member
|
/backport to stable32 |
Member
|
Thanks by your dedicated time 💚 |
This was referenced Mar 5, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #5534
Summary
This pull request updates the pull request template to improve structure and provide clearer guidance for contributors. The changes include:
These improvements address the feedback from the previous attempt (#6200) and align the template with current project needs.
New Pull Request Template
Below is the new template file content:
Example of Filled-out Template
Here is an example of how the template would be filled out for a hypothetical UI change (e.g., adjusting button styles):