Skip to content

Commit 8a008e5

Browse files
Add governance docs and support policy files
1 parent d6b5911 commit 8a008e5

4 files changed

Lines changed: 155 additions & 0 deletions

File tree

.github/CODEOWNERS

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Default ownership
2+
* @alexphillips-dev
3+
4+
# Critical paths
5+
/.github/ @alexphillips-dev
6+
/scripts/ @alexphillips-dev
7+
/src/ @alexphillips-dev
8+
/tests/ @alexphillips-dev
9+
/folderview.plus.plg @alexphillips-dev
10+
/folderview.plus.xml @alexphillips-dev

CONTRIBUTING.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Contributing to FolderView Plus
2+
3+
Thanks for helping improve FolderView Plus.
4+
5+
## Before You Start
6+
7+
- Search existing issues first:
8+
- Bugs: `Bug report` form
9+
- Features: `Feature request` form
10+
- Help: `Support / troubleshooting` form
11+
- Keep changes focused and scoped to one problem per pull request.
12+
13+
## Local Setup
14+
15+
1. Fork and clone the repository.
16+
2. Create a branch from `main`.
17+
3. Install required tools:
18+
- Node.js 20+
19+
- PHP
20+
- Bash + shellcheck
21+
22+
## Validation Checklist
23+
24+
Run these before opening a pull request:
25+
26+
```bash
27+
node --test tests/*.mjs
28+
bash scripts/release_guard.sh
29+
bash scripts/install_smoke.sh
30+
bash scripts/api_contract_guard.sh
31+
bash scripts/i18n_guard.sh
32+
bash scripts/lang_usage_guard.sh
33+
bash scripts/theme_scope_guard.sh
34+
bash scripts/perf_budget_guard.sh
35+
```
36+
37+
If testing against an Unraid box is available, also run:
38+
39+
```bash
40+
bash scripts/unraid_matrix_smoke.sh
41+
```
42+
43+
## Pull Request Expectations
44+
45+
- Include a clear summary of what changed and why.
46+
- Include screenshots for UI changes (desktop and mobile when relevant).
47+
- Update docs (`README.md`, `CHANGELOG-fixes.md`, or language files) when behavior changes.
48+
- Keep backwards compatibility unless the change is intentional and documented.
49+
50+
## Coding Standards
51+
52+
- Use ASCII unless a file already requires Unicode.
53+
- Keep naming and structure consistent with existing plugin files.
54+
- Prefer small, composable functions over large inline blocks.
55+
- Avoid introducing theme-breaking global selectors.
56+
57+
## Release and Versioning
58+
59+
- Version format: `YYYY.MM.DD.UU`
60+
- `UU` is zero-padded for stable Unraid update ordering.
61+
- Releases are prepared with `bash scripts/release_prepare.sh`.

SECURITY.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
| Version | Supported |
6+
| --- | --- |
7+
| `main` (current development) | yes |
8+
| Latest tagged release | yes |
9+
| Older releases | no |
10+
11+
## Reporting a Vulnerability
12+
13+
Please report security issues privately through GitHub Security Advisories:
14+
15+
1. Go to the repository `Security` tab.
16+
2. Select `Report a vulnerability`.
17+
3. Include:
18+
- affected version (`/boot/config/plugins/folderview.plus/version`)
19+
- Unraid version
20+
- reproduction steps
21+
- impact and expected risk
22+
- logs/screenshots if available
23+
24+
Do not open public issues for unpatched vulnerabilities.
25+
26+
## Response Targets
27+
28+
- Initial acknowledgement: within 72 hours
29+
- Triage and severity assessment: within 7 days
30+
- Fix or mitigation timeline: communicated after triage
31+
32+
## Security Scope
33+
34+
In-scope components include:
35+
36+
- plugin PHP API endpoints
37+
- client-side settings/runtime scripts
38+
- import/export and backup/restore flows
39+
- release packaging and update metadata
40+
41+
Out-of-scope:
42+
43+
- Unraid core vulnerabilities
44+
- third-party plugins/themes outside this repository

SUPPORT.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Support
2+
3+
Use the right channel so issues are handled quickly.
4+
5+
## Bug Reports
6+
7+
Open a GitHub issue using the `Bug report` form:
8+
9+
- https://github.com/alexphillips-dev/FolderView-Plus/issues/new/choose
10+
11+
Include:
12+
13+
- Unraid version
14+
- plugin version (`/boot/config/plugins/folderview.plus/version`)
15+
- clear reproduction steps
16+
- expected vs actual result
17+
- relevant screenshots/logs
18+
19+
## Feature Requests
20+
21+
Open a GitHub issue using the `Feature request` form:
22+
23+
- https://github.com/alexphillips-dev/FolderView-Plus/issues/new/choose
24+
25+
## Troubleshooting / Usage Help
26+
27+
Use the `Support / troubleshooting` issue form first:
28+
29+
- https://github.com/alexphillips-dev/FolderView-Plus/issues/new/choose
30+
31+
Community support thread:
32+
33+
- https://forums.unraid.net/topic/197631-plugin-folderview-plus/
34+
35+
## Security Reports
36+
37+
Do not post security vulnerabilities publicly.
38+
Report privately via the repository `Security` tab:
39+
40+
- https://github.com/alexphillips-dev/FolderView-Plus/security

0 commit comments

Comments
 (0)