diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 43d5946d7c..267ec72a76 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,66 +1,83 @@ -### Pull Request Description +## โ˜‘๏ธ Resolves +Fixes # +--- -### Related Issue - -Issue Number: +## ๐Ÿ“ Summary +Provide a short, clear summary of what this pull request does and why it is needed. -### Pull Request Type +--- - +> 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. -
-How to see this running using GitHub Codespaces - -### 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.
+ +--- + +## ๐ŸŽจ UI (Frontend) Changes + +> Complete this section only if this pull request includes UI changes. + +### ๐Ÿ–ผ๏ธ Screenshots / Screencasts + +๐Ÿš๏ธ Before | ๐Ÿก After +-- | -- +Screenshot before | Screenshot after + +### ๐Ÿšง UI Tasks +- [ ] 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) + +--- + +## ๐Ÿ› ๏ธ API / Backend Changes + +> Complete this section only if this pull request includes backend or API changes. + +### ๐Ÿšง API Tasks +- [ ] Backend logic implemented or updated +- [ ] API contracts reviewed +- [ ] Database or migration changes documented (if applicable) + +### ๐Ÿ API Checklist +- [ ] Unit and/or integration tests added, or not required +- [ ] API documentation in `docs/` updated (if required) +- [ ] 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. \ No newline at end of file