Skip to content

Commit 38a3bdb

Browse files
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 <dev.gcarvalho@gmail.com>
1 parent bc553ae commit 38a3bdb

1 file changed

Lines changed: 72 additions & 55 deletions

File tree

.github/pull_request_template.md

Lines changed: 72 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,83 @@
1-
### Pull Request Description
1+
<!--
2+
- 🚨 SECURITY INFO
3+
-
4+
- Before sending a pull request that fixes a security issue please report it via our HackerOne page (https://hackerone.com/nextcloud) following our security policy (https://nextcloud.com/security/). This allows us to coordinate the fix and release without potentially exposing all Nextcloud servers and users in the meantime.
5+
-->
6+
7+
* Resolves: # <!-- related github issue -->
8+
9+
## Summary
10+
11+
A concise description of what this PR does and why.
12+
13+
## How to test
14+
15+
<details>
16+
<summary>Instructions for running the app in Codespaces or local development</summary>
17+
18+
1. Open a Codespace using the `LibreSign` repository or start the container with `make dev-setup`.
19+
2. Build assets (`npm run watch` for frontend, `composer test:unit -- --filter ...` for backend).
20+
3. Execute the steps required to reproduce the changes (e.g. upload a PDF, open validation screen, call API endpoint).
21+
4. Verify that the behaviour matches the description above.
22+
23+
Feel free to paste terminal commands or URLs that help reviewers follow along.
24+
25+
</details>
226

27+
## UI / Front‑end changes
328

4-
### Related Issue
529
<!--
6-
If this PR is related to an issue, put here, if not, remove this block
30+
█████ █████ █████
31+
▒▒███ ▒▒███ ▒▒███
32+
▒███ ▒███ ▒███
33+
▒███ ▒███ ▒███
34+
▒███ ▒███ ▒███
35+
▒███ ▒███ ▒███
36+
▒▒████████ █████
37+
▒▒▒▒▒▒▒▒ ▒▒▒▒▒
38+
39+
Feel free to remove this section when your PR only affects the backend/API code.
740
-->
8-
Issue Number:
941

10-
### Pull Request Type
42+
- [ ] ... <!-- Describe the tasks performed here (e.g., layout adjustment, new feature X) -->
43+
- [ ] Screenshots before/after (add images or links)
44+
45+
| Before | After |
46+
| --- | --- |
47+
| <!-- Add screenshot → | ← Add screenshot → |
48+
49+
<!-- ☀️ Light theme | 🌑 Dark theme → Please test and document both themes (important for Nextcloud apps) -->
50+
51+
- [ ] Tested in multiple browsers (Chrome, Firefox, Safari) – *optional but appreciated*
52+
- [ ] Accessibility verified (contrast, keyboard navigation, screen reader friendly) – *if applicable*
53+
- [ ] Design review approved – *optional, link to feedback if available*
54+
- [ ] User documentation updated (if applicable) – [user manual](https://docs.libresign.coop/user_manual/) / [docs repository](https://github.com/LibreSign/documentation/)
55+
56+
## API / Back‑end changes
1157

1258
<!--
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):
59+
█████████ ███████████ █████
60+
███▒▒▒▒▒███ ▒▒███▒▒▒▒▒███▒▒███
61+
▒███ ▒███ ▒███ ▒███ ▒███
62+
▒███████████ ▒██████████ ▒███
63+
▒███▒▒▒▒▒███ ▒███▒▒▒▒▒▒ ▒███
64+
▒███ ▒███ ▒███ ▒███
65+
█████ █████ █████ █████
66+
▒▒▒▒▒ ▒▒▒▒▒ ▒▒▒▒▒ ▒▒▒▒▒
67+
68+
Feel free to remove this section when your PR only affects the frontend/UI code.
2269
-->
2370

24-
### Pull request checklist
71+
- [ ] ... <!-- Describe the API/service/architecture changes here -->
72+
- [ ] Unit and/or integration tests added – *required for backend changes*
73+
- [ ] Capabilities updated (if applicable) – if adding/modifying Nextcloud capabilities
74+
- [ ] API documentation updated with the command `composer openapi` if necessary <!-- This generates the openapi.json file -->
2575

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
76+
## ✅ Checklist
3177

32-
<details>
33-
<summary>How to see this running using GitHub Codespaces</summary>
34-
35-
### 1. Open the Codespace
36-
- Authenticate to GitHub
37-
- Go to the branch: [chore/reduce-configure-check-time](https://github.com/LibreSign/libresign/tree/chore/reduce-configure-check-time)
38-
- Click the `Code` button and select the `Codespaces` tab.
39-
- Click **"Create codespace on feat/customize-signature-stamp"**
40-
41-
### 2. Wait for the environment to start
42-
- A progress bar will appear on the left.
43-
- After that, the terminal will show the build process.
44-
- Wait until you see the message:
45-
```bash
46-
✍️ LibreSign is up!
47-
```
48-
This may take a few minutes.
49-
50-
### 3. Access LibreSign in the browser
51-
- Open the **Ports** tab (next to the **Terminal**).
52-
- Look for the service running on port **80**.
53-
- Hover over the URL and click the **globe icon** 🌐 to open it in your browser.
54-
55-
### 4. (Optional) Make the service public
56-
- If you want to share the app with people **not logged in to GitHub**, you must change the port visibility:
57-
- Click the three dots `` on the row for port 80.
58-
- Select `Change visibility``Public`.
59-
60-
### 5. Login credentials
61-
- **Username**: `admin`
62-
- **Password**: `admin`
63-
64-
Done! 🎉
65-
You're now ready to test this.
66-
</details>
78+
- [ ] I have read and followed the [contribution guide](CONTRIBUTING.md).
79+
- [ ] ... (list your own tasks here)
80+
81+
## AI (if applicable)
82+
83+
- [ ] The content of this PR was partially or fully generated using AI

0 commit comments

Comments
 (0)