Skip to content

Commit 6187ef6

Browse files
chore: refactor pull request template incorporating review 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 #5534 Signed-off-by: Guilherme Carvalho <dev.gcarvalho@gmail.com>
1 parent 38a3bdb commit 6187ef6

1 file changed

Lines changed: 49 additions & 21 deletions

File tree

.github/pull_request_template.md

Lines changed: 49 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
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 -->
1+
Resolves: # <!-- related github issue -->
82

93
## Summary
104

@@ -13,15 +7,39 @@ A concise description of what this PR does and why.
137
## How to test
148

159
<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-
10+
<summary>How to see this running using GitHub Codespaces</summary>
11+
12+
### 1. Open the Codespace
13+
- Authenticate to GitHub
14+
- Go to the branch: [chore/reduce-configure-check-time](https://github.com/LibreSign/libresign/tree/chore/reduce-configure-check-time)
15+
- Click the `Code` button and select the `Codespaces` tab.
16+
- Click **"Create codespace on feat/customize-signature-stamp"**
17+
18+
### 2. Wait for the environment to start
19+
- A progress bar will appear on the left.
20+
- After that, the terminal will show the build process.
21+
- Wait until you see the message:
22+
```bash
23+
✍️ LibreSign is up!
24+
```
25+
This may take a few minutes.
26+
27+
### 3. Access LibreSign in the browser
28+
- Open the **Ports** tab (next to the **Terminal**).
29+
- Look for the service running on port **80**.
30+
- Hover over the URL and click the **globe icon** 🌐 to open it in your browser.
31+
32+
### 4. (Optional) Make the service public
33+
- If you want to share the app with people **not logged in to GitHub**, you must change the port visibility:
34+
- Click the three dots `` on the row for port 80.
35+
- Select `Change visibility``Public`.
36+
37+
### 5. Login credentials
38+
- **Username**: `admin`
39+
- **Password**: `admin`
40+
41+
Done! 🎉
42+
You're now ready to test this.
2543
</details>
2644

2745
## UI / Front‑end changes
@@ -42,16 +60,21 @@ Feel free to remove this section when your PR only affects the backend/API code.
4260
- [ ] ... <!-- Describe the tasks performed here (e.g., layout adjustment, new feature X) -->
4361
- [ ] Screenshots before/after (add images or links)
4462

45-
| Before | After |
46-
| --- | --- |
47-
| <!-- Add screenshot → | ← Add screenshot → |
63+
### 🚧 Tasks
64+
<!-- 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 -->
65+
- [ ] ...
4866

49-
<!-- ☀️ Light theme | 🌑 Dark theme → Please test and document both themes (important for Nextcloud apps) -->
67+
🏚️ Before | 🏡 After
68+
--- | ---
69+
<!-- Add screenshot --> | <!-- Add screenshot -->
70+
71+
<!-- ☀️ Light theme | 🌑 Dark theme → Please test and document both themes -->
5072

5173
- [ ] Tested in multiple browsers (Chrome, Firefox, Safari) – *optional but appreciated*
74+
- [ ] Components, Unit (with vitest) and/or e2e (with Playwright) tests added - *Required*
5275
- [ ] Accessibility verified (contrast, keyboard navigation, screen reader friendly) – *if applicable*
5376
- [ ] 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/)
77+
- [ ] Documentation updated (if applicable) – [docs repository](https://github.com/LibreSign/documentation/)
5578

5679
## API / Back‑end changes
5780

@@ -71,8 +94,13 @@ Feel free to remove this section when your PR only affects the frontend/UI code.
7194
- [ ] ... <!-- Describe the API/service/architecture changes here -->
7295
- [ ] Unit and/or integration tests added – *required for backend changes*
7396
- [ ] Capabilities updated (if applicable) – if adding/modifying Nextcloud capabilities
97+
- [ ] Documentation updated (if applicable) - [docs repository](https://github.com/LibreSign/documentation)
7498
- [ ] API documentation updated with the command `composer openapi` if necessary <!-- This generates the openapi.json file -->
7599

100+
### 🚧 Tasks
101+
<!-- 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 -->
102+
- [ ] ...
103+
76104
## ✅ Checklist
77105

78106
- [ ] I have read and followed the [contribution guide](CONTRIBUTING.md).

0 commit comments

Comments
 (0)