dev: Added contributor guidelines and updated the PR template

This commit is contained in:
lscambo13
2025-05-31 07:58:34 -07:00
parent e00277056c
commit de17544fb4
4 changed files with 104 additions and 29 deletions

47
.github/PULL_REQUEST_TEMPLATE.yml vendored Normal file
View File

@@ -0,0 +1,47 @@
name: Pull Request
description: Submit a contribution to ElegantFin
title: "[PR] <Short title for your changes>"
labels: []
assignees: []
body:
- type: markdown
attributes:
value: |
Please follow our [Contributor Guidelines](../CONTRIBUTING.md) and keep your PR focused on a single improvement or fix.
- type: textarea
id: description
attributes:
label: Description
description: Describe your changes and the reason behind them.
placeholder: What did you change and why?
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Add before/after images of any visual changes.
placeholder: Drag and drop or paste images here.
validations:
required: false
- type: textarea
id: testing
attributes:
label: Cross-platform Testing
description: Describe how you verified this works across devices (e.g., desktop, mobile, TV).
validations:
required: true
- type: checkboxes
id: checklist
attributes:
label: Checklist
options:
- label: I followed the style conventions (`em` units, minimal media queries).
required: true
- label: I avoided unnecessary use of `!important`.
required: true
- label: I commented my code where applicable.
required: true
- label: I tested my changes across viewports.
required: true

View File

@@ -1,28 +0,0 @@
# Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
Fixes # (issue)
## Type of change
- [ ] Bug fix
- [ ] New feature
# How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
**Test Configuration**:
* Jellyfin server version:
* Jellyfin client:
* Client browser name and version:
* Device:
# Checklist:
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code in hard-to-understand areas
- [ ] I have included relevant comparison screenshots where nececssary
- [ ] I have tested my changes on the TV layout and Default layout of Jellyfin
- [ ] I have also tested my changes on multiple devices and screen sizes