Skip to content
Merged
Changes from all commits
Commits
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
112 changes: 85 additions & 27 deletions .github/pull_request_template.md
Comment thread
vitormattos marked this conversation as resolved.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I included a comment clarifying that the Codespaces block is a permanent part of the template, but that specific testing instructions must be written manually for each PR. This addresses the requirement from issue #5534 to retain the Codespaces instructions while also guiding contributors on how to use the template correctly.

Original file line number Diff line number Diff line change
@@ -1,33 +1,23 @@
### Pull Request Description
Resolves: # <!-- related github issue -->

## ๐Ÿ“ Summary

### Related Issue
<!--
If this PR is related to an issue, put here, if not, remove this block
-->
Issue Number:

### Pull Request Type
A concise description of what this PR does and why.

## ๐Ÿงช How to test
<!--
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:

- Bugfix
- Feature
- Code style update (formatting, renaming)
- Refactoring (no functional changes, no api changes)
- Build related changes
- Documentation content changes
- Other (please describe):
-->
IMPORTANT: The "How to see this running using GitHub Codespaces" details block SHOULD NOT be included in the final template.
Testing instructions should be written specifically for each PR,
describing the steps needed to validate the proposed changes.

### Pull request checklist
Example:
1. Access the signatures page
2. Upload a test PDF
3. Click "Sign" and verify the modal opens correctly
4. Confirm the signature was applied

- [ ] 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
Feel free to paste terminal commands or URLs that help reviewers follow along.
-->

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

### 2. Wait for the environment to start
- A progress bar will appear on the left.
- A progress bar will appear on the left.
- After that, the terminal will show the build process.
- Wait until you see the message:
- Wait until you see the message:
```bash
โœ๏ธ LibreSign is up!
```
Expand All @@ -58,9 +48,77 @@ Please check the type of change your pull request introduces. Remove all that is
- Select `Change visibility` โ†’ `Public`.

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

Done! ๐ŸŽ‰
You're now ready to test this.
</details>

## ๐ŸŽจ UI / Frontโ€‘end changes

<!--
โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ
โ–’โ–’โ–ˆโ–ˆโ–ˆ โ–’โ–’โ–ˆโ–ˆโ–ˆ โ–’โ–’โ–ˆโ–ˆโ–ˆ
โ–’โ–ˆโ–ˆโ–ˆ โ–’โ–ˆโ–ˆโ–ˆ โ–’โ–ˆโ–ˆโ–ˆ
โ–’โ–ˆโ–ˆโ–ˆ โ–’โ–ˆโ–ˆโ–ˆ โ–’โ–ˆโ–ˆโ–ˆ
โ–’โ–ˆโ–ˆโ–ˆ โ–’โ–ˆโ–ˆโ–ˆ โ–’โ–ˆโ–ˆโ–ˆ
โ–’โ–ˆโ–ˆโ–ˆ โ–’โ–ˆโ–ˆโ–ˆ โ–’โ–ˆโ–ˆโ–ˆ
โ–’โ–’โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ
โ–’โ–’โ–’โ–’โ–’โ–’โ–’โ–’ โ–’โ–’โ–’โ–’โ–’

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

- [ ] ... <!-- Describe the tasks performed here (e.g., layout adjustment, new feature X) -->
- [ ] Screenshots before/after (add images or links)

### ๐Ÿšง Tasks
<!-- 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 -->
- [ ] ...

๐Ÿš๏ธ Before | ๐Ÿก After
--- | ---
Screenshot before | Screenshot after

<!-- โ˜€๏ธ Light theme | ๐ŸŒ‘ Dark theme โ†’ Please test and document both themes -->

- [ ] Tested in multiple browsers (Chrome, Firefox, Safari) โ€“ *optional but appreciated*
Comment thread
vitormattos marked this conversation as resolved.
- [ ] Components, Unit (with vitest) and/or e2e (with Playwright) tests added - *Required*
- [ ] Accessibility verified (contrast, keyboard navigation, screen reader friendly) โ€“ *if applicable*
- [ ] Design review approved โ€“ *optional, link to feedback if available*
- [ ] Documentation updated (if applicable) โ€“ [docs repository](https://github.com/LibreSign/documentation/)

Comment thread
guilhermercarvalho marked this conversation as resolved.
## โš™๏ธ API / Backโ€‘end changes

<!--
โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ
โ–ˆโ–ˆโ–ˆโ–’โ–’โ–’โ–’โ–’โ–ˆโ–ˆโ–ˆ โ–’โ–’โ–ˆโ–ˆโ–ˆโ–’โ–’โ–’โ–’โ–’โ–ˆโ–ˆโ–ˆโ–’โ–’โ–ˆโ–ˆโ–ˆ
โ–’โ–ˆโ–ˆโ–ˆ โ–’โ–ˆโ–ˆโ–ˆ โ–’โ–ˆโ–ˆโ–ˆ โ–’โ–ˆโ–ˆโ–ˆ โ–’โ–ˆโ–ˆโ–ˆ
โ–’โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ โ–’โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ โ–’โ–ˆโ–ˆโ–ˆ
โ–’โ–ˆโ–ˆโ–ˆโ–’โ–’โ–’โ–’โ–’โ–ˆโ–ˆโ–ˆ โ–’โ–ˆโ–ˆโ–ˆโ–’โ–’โ–’โ–’โ–’โ–’ โ–’โ–ˆโ–ˆโ–ˆ
โ–’โ–ˆโ–ˆโ–ˆ โ–’โ–ˆโ–ˆโ–ˆ โ–’โ–ˆโ–ˆโ–ˆ โ–’โ–ˆโ–ˆโ–ˆ
โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ
โ–’โ–’โ–’โ–’โ–’ โ–’โ–’โ–’โ–’โ–’ โ–’โ–’โ–’โ–’โ–’ โ–’โ–’โ–’โ–’โ–’

Feel free to remove this section when your PR only affects the frontend/UI code.
-->

- [ ] ... <!-- Describe the API/service/architecture changes here -->
- [ ] Unit and/or integration tests added โ€“ *required for backend changes*
- [ ] Capabilities updated (if applicable) โ€“ if adding/modifying Nextcloud capabilities
Comment thread
guilhermercarvalho marked this conversation as resolved.
- [ ] Documentation updated (if applicable) - [docs repository](https://github.com/LibreSign/documentation)
- [ ] API documentation updated with the command `composer openapi` if necessary <!-- This generates the openapi.json file -->

### ๐Ÿšง Tasks
<!-- 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 -->
- [ ] ...

## โœ… Checklist

- [ ] I have read and followed the [contribution guide](CONTRIBUTING.md).
- [ ] ... (list your own tasks here)
Comment thread
guilhermercarvalho marked this conversation as resolved.

## ๐Ÿค– AI (if applicable)

- [ ] The content of this PR was partially or fully generated using AI
Loading