Skip to content

Commit 4c0d371

Browse files
vitormattosvitormattos
authored
Merge pull request #7083 from LibreSign/backport/7072/stable33
[stable33] chore: refactor pull request template for better structure and guidance
2 parents bc553ae + 8996e5c commit 4c0d371

1 file changed

Lines changed: 85 additions & 27 deletions

File tree

‎.github/pull_request_template.md‎

Lines changed: 85 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,23 @@
1-
### Pull Request Description
1+
Resolves: # <!-- related github issue -->
22

3+
## 📝 Summary
34

4-
### Related Issue
5-
<!--
6-
If this PR is related to an issue, put here, if not, remove this block
7-
-->
8-
Issue Number:
9-
10-
### Pull Request Type
5+
A concise description of what this PR does and why.
116

7+
## 🧪 How to test
128
<!--
13-
Please check the type of change your pull request introduces. Remove all that is unrelated and remove the comment block too, maintaining only the type of your PR:
14-
15-
- Bugfix
16-
- Feature
17-
- Code style update (formatting, renaming)
18-
- Refactoring (no functional changes, no api changes)
19-
- Build related changes
20-
- Documentation content changes
21-
- Other (please describe):
22-
-->
9+
IMPORTANT: The "How to see this running using GitHub Codespaces" details block SHOULD NOT be included in the final template.
10+
Testing instructions should be written specifically for each PR,
11+
describing the steps needed to validate the proposed changes.
2312
24-
### Pull request checklist
13+
Example:
14+
1. Access the signatures page
15+
2. Upload a test PDF
16+
3. Click "Sign" and verify the modal opens correctly
17+
4. Confirm the signature was applied
2518
26-
- [ ] Did you explain or provide a way of how can we test your code ?
27-
- [ ] If your pull request is related to frontend modifications provide a print of before and after screen
28-
- [ ] Did you provide a general summary of your changes ?
29-
- [ ] Try to limit your pull request to one type, submit multiple pull requests if needed
30-
- [ ] I implemented tests that cover my contribution
19+
Feel free to paste terminal commands or URLs that help reviewers follow along.
20+
-->
3121

3222
<details>
3323
<summary>How to see this running using GitHub Codespaces</summary>
@@ -39,9 +29,9 @@ Please check the type of change your pull request introduces. Remove all that is
3929
- Click **"Create codespace on feat/customize-signature-stamp"**
4030

4131
### 2. Wait for the environment to start
42-
- A progress bar will appear on the left.
32+
- A progress bar will appear on the left.
4333
- After that, the terminal will show the build process.
44-
- Wait until you see the message:
34+
- Wait until you see the message:
4535
```bash
4636
✍️ LibreSign is up!
4737
```
@@ -58,9 +48,77 @@ Please check the type of change your pull request introduces. Remove all that is
5848
- Select `Change visibility` → `Public`.
5949

6050
### 5. Login credentials
61-
- **Username**: `admin`
51+
- **Username**: `admin`
6252
- **Password**: `admin`
6353

6454
Done! 🎉
6555
You're now ready to test this.
6656
</details>
57+
58+
## 🎨 UI / Front‑end changes
59+
60+
<!--
61+
█████ █████ █████
62+
▒▒███ ▒▒███ ▒▒███
63+
▒███ ▒███ ▒███
64+
▒███ ▒███ ▒███
65+
▒███ ▒███ ▒███
66+
▒███ ▒███ ▒███
67+
▒▒████████ █████
68+
▒▒▒▒▒▒▒▒ ▒▒▒▒▒
69+
70+
Feel free to remove this section when your PR only affects the backend/API code.
71+
-->
72+
73+
- [ ] ... <!-- Describe the tasks performed here (e.g., layout adjustment, new feature X) -->
74+
- [ ] Screenshots before/after (add images or links)
75+
76+
### 🚧 Tasks
77+
<!-- Add here the list of tasks that is necessary to do before merge this PR. As example: update the package X, merge the PR y. If isn't necessary, fell free to remove this block -->
78+
- [ ] ...
79+
80+
🏚️ Before | 🏡 After
81+
--- | ---
82+
Screenshot before | Screenshot after
83+
84+
<!-- ☀️ Light theme | 🌑 Dark theme → Please test and document both themes -->
85+
86+
- [ ] Tested in multiple browsers (Chrome, Firefox, Safari) – *optional but appreciated*
87+
- [ ] Components, Unit (with vitest) and/or e2e (with Playwright) tests added - *Required*
88+
- [ ] Accessibility verified (contrast, keyboard navigation, screen reader friendly) – *if applicable*
89+
- [ ] Design review approved – *optional, link to feedback if available*
90+
- [ ] Documentation updated (if applicable) – [docs repository](https://github.com/LibreSign/documentation/)
91+
92+
## ⚙️ API / Back‑end changes
93+
94+
<!--
95+
█████████ ███████████ █████
96+
███▒▒▒▒▒███ ▒▒███▒▒▒▒▒███▒▒███
97+
▒███ ▒███ ▒███ ▒███ ▒███
98+
▒███████████ ▒██████████ ▒███
99+
▒███▒▒▒▒▒███ ▒███▒▒▒▒▒▒ ▒███
100+
▒███ ▒███ ▒███ ▒███
101+
█████ █████ █████ █████
102+
▒▒▒▒▒ ▒▒▒▒▒ ▒▒▒▒▒ ▒▒▒▒▒
103+
104+
Feel free to remove this section when your PR only affects the frontend/UI code.
105+
-->
106+
107+
- [ ] ... <!-- Describe the API/service/architecture changes here -->
108+
- [ ] Unit and/or integration tests added – *required for backend changes*
109+
- [ ] Capabilities updated (if applicable) – if adding/modifying Nextcloud capabilities
110+
- [ ] Documentation updated (if applicable) - [docs repository](https://github.com/LibreSign/documentation)
111+
- [ ] API documentation updated with the command `composer openapi` if necessary <!-- This generates the openapi.json file -->
112+
113+
### 🚧 Tasks
114+
<!-- Add here the list of tasks that is necessary to do before merge this PR. As example: update the package X, merge the PR y. If isn't necessary, fell free to remove this block -->
115+
- [ ] ...
116+
117+
## ✅ Checklist
118+
119+
- [ ] I have read and followed the [contribution guide](CONTRIBUTING.md).
120+
- [ ] ... (list your own tasks here)
121+
122+
## 🤖 AI (if applicable)
123+
124+
- [ ] The content of this PR was partially or fully generated using AI

0 commit comments

Comments
 (0)