Skip to content

chore: refactor pull request template for better structure and UI guidance #6200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
s3arthak wants to merge 3 commits into from
Closed

chore: refactor pull request template for better structure and UI guidance #6200

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2762962
chore: refactor pull request template for better structure and UI gui…
s3arthak Dec 15, 2025
990302f
chore: align pull request template with existing Codespaces and UI co…
s3arthak Dec 15, 2025
0a20038
chore(docs): refactor pull request template for clearer UI and API gu…
s3arthak Dec 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 74 additions & 57 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,66 +1,83 @@
### Pull Request Description
## ☑️ Resolves
Fixes #<issue-number>

---

### Related Issue
<!--
If this PR is related to an issue, put here, if not, remove this block
-->
Issue Number:
## 📝 Summary
Provide a short, clear summary of what this pull request does and why it is needed.

### Pull Request Type
---

<!--
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:
<details>
Copy link
Copy Markdown
Member

@vitormattos vitormattos Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be helpful to move this block to the end of the document for better organization, as per the original template.

I noticed that the AI prompt removed many code details and made several changes. Could you clarify the reasoning behind these adjustments?

<summary>🧪 How to Test (GitHub Codespaces)</summary>

- Bugfix
- Feature
- Code style update (formatting, renaming)
- Refactoring (no functional changes, no api changes)
- Build related changes
- Documentation content changes
- Other (please describe):
-->
> Follow these steps to test this pull request using GitHub Codespaces.

### Pull request checklist
1. Open the repository and click **Code → Codespaces**
2. Create a new Codespace for this branch
3. Wait for the environment to finish setting up
You should see:
✍️ LibreSign is up!
4. Open the **Ports** tab
5. Open the service running on **port 80**
6. Login using:
- **Username:** admin
- **Password:** admin

- [ ] Did you explain or provide a way of how can we test your code ?
- [ ] If your pull request is related to frontend modifications provide a print of before and after screen
- [ ] Did you provide a general summary of your changes ?
- [ ] Try to limit your pull request to one type, submit multiple pull requests if needed
- [ ] I implemented tests that cover my contribution
Done! 🎉 You are now ready to test this.

<details>
<summary>How to see this running using GitHub Codespaces</summary>

### 1. Open the Codespace
- Authenticate to GitHub
- Go to the branch: [chore/reduce-configure-check-time](https://github.com/LibreSign/libresign/tree/chore/reduce-configure-check-time)
- Click the `Code` button and select the `Codespaces` tab.
- Click **"Create codespace on feat/customize-signature-stamp"**

### 2. Wait for the environment to start
- A progress bar will appear on the left.
- After that, the terminal will show the build process.
- Wait until you see the message:
```bash
✍️ LibreSign is up!
```
This may take a few minutes.

### 3. Access LibreSign in the browser
- Open the **Ports** tab (next to the **Terminal**).
- Look for the service running on port **80**.
- Hover over the URL and click the **globe icon** 🌐 to open it in your browser.

### 4. (Optional) Make the service public
- If you want to share the app with people **not logged in to GitHub**, you must change the port visibility:
- Click the three dots `⋮` on the row for port 80.
- Select `Change visibility` → `Public`.

### 5. Login credentials
- **Username**: `admin`
- **Password**: `admin`

Done! 🎉
You're now ready to test this.
</details>

---

## 🎨 UI (Frontend) Changes

> Complete this section only if this pull request includes UI changes.
Copy link
Copy Markdown
Member

@vitormattos vitormattos Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example template contains a code snippet within comments, such as:

<!--
░░░░░░░░░░░░░░░░░░░░░
░█████░░██████░█████░
░░███░░░░███░░░███░░
░░███ ░░░░███░░░███░░
░░███░░░░███░░░███░░
░░░█████████░░░█████░
░░░░░░░░░░░░░░░░░░░░

Feel free to remove this section when your PR only affects The backend/API code.
-->

This way, anyone opening a new PR will be notified that if it's only about the frontend, they should remove the backend section; otherwise, if it's only about the backend, they should remove the frontend section.


### 🖼️ Screenshots / Screencasts

🏚️ Before | 🏡 After
-- | --
Screenshot before | Screenshot after
Copy link
Copy Markdown
Member

@vitormattos vitormattos Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At the example, also have instructions about light and dark theme inside a comment that would be good to have here.

Suggested change
Screenshot before | Screenshot after
Screenshot before | Screenshot after
<!-- ☀️ Light theme | 🌑 Dark Theme -->


### 🚧 UI Tasks
- [ ] UI changes implemented
- [ ] Visual consistency checked
- [ ] Accessibility considerations applied (if applicable)
Comment on lines +44 to +46
Copy link
Copy Markdown
Member

@vitormattos vitormattos Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The idea is to the developer create the tasks herself describing what's made and what's pending. Maybe with ellipsis could give this idea, or maybe also would be good to have a visible hidden comment here too explaining that, like - [ ] <!-- your tasks here -->

Suggested change
- [ ] UI changes implemented
- [ ] Visual consistency checked
- [ ] Accessibility considerations applied (if applicable)
- [ ] ...


### 🏁 UI Checklist
- [ ] Tested on Chromium-based browsers (Chrome / Edge / Brave)
- [ ] Tested on Firefox
- [ ] UI does not rely on browser-specific behavior
- [ ] Design reviewed, approved, or inspired by existing LibreSign / Nextcloud UI
- [ ] User-facing documentation updated (if required)
Copy link
Copy Markdown
Member

@vitormattos vitormattos Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe would be good to have a reference to user documentation of LibreSign website: https://docs.libresign.coop/user_manual/ and repository of website: https://github.com/LibreSign/documentation/ together with this item


---

## 🛠️ API / Backend Changes

> Complete this section only if this pull request includes backend or API changes.
Copy link
Copy Markdown
Member

@vitormattos vitormattos Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comment about frontend that I made before.


### 🚧 API Tasks
- [ ] Backend logic implemented or updated
- [ ] API contracts reviewed
- [ ] Database or migration changes documented (if applicable)
Comment on lines +62 to +64
Copy link
Copy Markdown
Member

@vitormattos vitormattos Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The same as previous comment about tasks


### 🏁 API Checklist
- [ ] Unit and/or integration tests added, or not required
- [ ] API documentation in `docs/` updated (if required)
Copy link
Copy Markdown
Member

@vitormattos vitormattos Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The API documentation for LibreSign is not found in the docs folder. Instead, it is generated using the Composer command: composer openapi, which updates the openapi.json file. It would be beneficial to include a link to the developer documentation and to create an issue in the LibreSign documentation repository outlining how to use composer openapi. This issue should offer specific instructions tailored to LibreSign, since the Nextcloud developer documentation already covers the general process of generating OpenAPI documentation: Nextcloud Developer Manual.

Suggested change
- [ ] API documentation in `docs/` updated (if required)
- [ ] API documentation updated with the command `composer openapi` if necessary

- [ ] Capability added or confirmed not needed

---

## 📋 General Checklist
- [ ] PR is focused on a single concern
- [ ] Code follows project conventions
- [ ] Relevant tests added or justified
- [ ] Documentation updated if needed
- [ ] No breaking changes (or clearly documented)

---

## ℹ️ Additional Notes
Add any additional context if necessary.
Comment on lines +71 to +83
Copy link
Copy Markdown
Member

@vitormattos vitormattos Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like there is too much information required when creating a PR.

Suggested change
---
## 📋 General Checklist
- [ ] PR is focused on a single concern
- [ ] Code follows project conventions
- [ ] Relevant tests added or justified
- [ ] Documentation updated if needed
- [ ] No breaking changes (or clearly documented)
---
## ℹ️ Additional Notes
Add any additional context if necessary.