Skip to content

Commit 2762962

Browse files
committed
chore: refactor pull request template for better structure and UI guidance
Signed-off-by: Sarthak Kharka <[email protected]> :wq
1 parent 792690a commit 2762962

1 file changed

Lines changed: 80 additions & 66 deletions

File tree

.github/pull_request_template.md

Lines changed: 80 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,80 @@
1-
### Pull Request Description
2-
3-
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
11-
12-
<!--
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-
-->
23-
24-
### Pull request checklist
25-
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
31-
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>
1+
## ☑️ Resolves
2+
Fixes #<issue-number>
3+
4+
---
5+
6+
## 📝 Summary
7+
Provide a short, clear summary of what this pull request does and why it is needed.
8+
9+
---
10+
11+
## 🧪 How to Test (GitHub Codespaces)
12+
13+
> Follow these steps to test this pull request using GitHub Codespaces.
14+
15+
1. Open the repository and click **Code → Codespaces**
16+
2. Create a new Codespace for this branch
17+
3. Wait for the environment to finish setting up
18+
You should see:
19+
✍️ LibreSign is up!
20+
4. Open the **Ports** tab
21+
5. Open the service running on **port 80**
22+
6. Login using:
23+
- **Username:** admin
24+
- **Password:** admin
25+
26+
Done! 🎉 You are now ready to test this.
27+
28+
---
29+
30+
## 🎨 UI (Frontend) Changes
31+
32+
> Complete this section only if this pull request includes UI changes.
33+
34+
### 🖼️ Screenshots / Screencasts
35+
36+
| Before | After |
37+
|--------|-------|
38+
| _Insert screenshot_ | _Insert screenshot_ |
39+
40+
### 🚧 UI Tasks
41+
- [ ] UI changes implemented
42+
- [ ] Visual consistency checked
43+
- [ ] Accessibility considerations applied (if applicable)
44+
45+
### 🏁 UI Checklist
46+
- [ ] Tested on Chromium-based browsers (Chrome / Edge / Brave)
47+
- [ ] Tested on Firefox
48+
- [ ] UI does not rely on browser-specific behavior
49+
- [ ] Design reviewed, approved, or inspired by existing LibreSign / Nextcloud UI
50+
- [ ] User-facing documentation updated (if required)
51+
52+
---
53+
54+
## 🛠️ API / Backend Changes
55+
56+
> Complete this section only if this pull request includes backend or API changes.
57+
58+
### 🚧 API Tasks
59+
- [ ] Backend logic implemented or updated
60+
- [ ] API contracts reviewed
61+
- [ ] Database or migration changes documented (if applicable)
62+
63+
### 🏁 API Checklist
64+
- [ ] Unit and/or integration tests added, or not required
65+
- [ ] API documentation in `docs/` updated (if required)
66+
- [ ] Capability added or confirmed not needed
67+
68+
---
69+
70+
## 📋 General Checklist
71+
- [ ] PR is focused on a single concern
72+
- [ ] Code follows project conventions
73+
- [ ] Relevant tests added or justified
74+
- [ ] Documentation updated if needed
75+
- [ ] No breaking changes (or clearly documented)
76+
77+
---
78+
79+
## ℹ️ Additional Notes
80+
Add any additional context if necessary.

0 commit comments

Comments
 (0)