Add public issue and contribution guidance

This commit is contained in:
2026-08-23 12:29:40 -05:00
parent 43698afd7e
commit ad06125f35
9 changed files with 340 additions and 5 deletions
+93
View File
@@ -0,0 +1,93 @@
name: Bug Report
about: Report a reproducible problem in Dark Mode by GracePress
title: "[Bug] "
labels:
- bug
- needs triage
body:
- type: markdown
attributes:
value: |
Thank you for reporting a problem. Do not include passwords, tokens, private URLs, customer information, or security vulnerabilities. Report vulnerabilities privately using SECURITY.md.
- type: input
id: plugin-version
attributes:
label: Plugin version
description: Find this in Plugins or the plugin file header.
placeholder: "4.8.18"
validations:
required: true
- type: input
id: wordpress-version
attributes:
label: WordPress version
placeholder: "6.x"
validations:
required: true
- type: input
id: php-version
attributes:
label: PHP version
placeholder: "8.x"
validations:
required: true
- type: input
id: environment
attributes:
label: Browser, theme, and relevant plugins
description: Include versions where known.
placeholder: "Firefox; Twenty Twenty-Six; no other dark-mode plugin"
validations:
required: true
- type: dropdown
id: surface
attributes:
label: Affected area
options:
- Public website
- WordPress administration
- Both
- Installation or activation
- Settings and persistence
- Unsure
validations:
required: true
- type: textarea
id: steps
attributes:
label: Reproduction steps
description: Give the smallest exact sequence that demonstrates the problem.
placeholder: |
1. Enable...
2. Visit...
3. Select...
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected result
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual result
validations:
required: true
- type: textarea
id: evidence
attributes:
label: Sanitized screenshots or logs
description: Remove secrets and private information before attaching anything.
- type: checkboxes
id: confirmation
attributes:
label: Confirmation
options:
- label: I searched existing issues for this problem.
required: true
- label: I removed secrets and private information from this report.
required: true
- label: This is not a security vulnerability.
required: true
@@ -0,0 +1,65 @@
name: Compatibility Report
about: Report a conflict with WordPress, PHP, a browser, theme, or another plugin
title: "[Compatibility] "
labels:
- compatibility
- needs triage
body:
- type: markdown
attributes:
value: |
Use this form when Dark Mode works generally but conflicts with a particular environment. Do not include credentials, private data, or security vulnerabilities.
- type: input
id: plugin-version
attributes:
label: Dark Mode version
placeholder: "4.8.18"
validations:
required: true
- type: input
id: wordpress-php
attributes:
label: WordPress and PHP versions
placeholder: "WordPress 6.x; PHP 8.x"
validations:
required: true
- type: input
id: conflicting-component
attributes:
label: Conflicting component
description: Name the browser, theme, plugin, host, or WordPress feature and include its version.
validations:
required: true
- type: dropdown
id: surface
attributes:
label: Affected area
options:
- Public website
- WordPress administration
- Both
- Unsure
validations:
required: true
- type: textarea
id: behavior
attributes:
label: Conflict description and reproduction steps
validations:
required: true
- type: textarea
id: isolation
attributes:
label: Isolation already attempted
description: Explain what happens when the theme, plugin, browser extension, cache, or optimization is disabled.
- type: checkboxes
id: confirmation
attributes:
label: Confirmation
options:
- label: I searched existing issues.
required: true
- label: I removed secrets and private information.
required: true
- label: This is not a security vulnerability.
required: true
+8
View File
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Private security report
url: mailto:jason@christit.com?subject=Dark%20Mode%20by%20GracePress%20security%20report
about: Report vulnerabilities privately. Do not disclose security issues in public.
- name: Public plugin page
url: https://christit.com/gracepress/plugins/dark-mode-by-gracepress/
about: Read the public overview and current release status.
@@ -0,0 +1,41 @@
name: Feature Request
about: Propose a focused improvement to Dark Mode by GracePress
title: "[Feature] "
labels:
- enhancement
- needs triage
body:
- type: markdown
attributes:
value: |
Explain the user problem before proposing an implementation. Dark Mode intentionally avoids paywalls, telemetry, required remote services, and unnecessary administration notices.
- type: textarea
id: problem
attributes:
label: Problem to solve
description: What cannot be accomplished with the current plugin?
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposed behavior
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
- type: textarea
id: impact
attributes:
label: Compatibility and accessibility considerations
- type: checkboxes
id: confirmation
attributes:
label: Confirmation
options:
- label: I searched existing issues and documentation.
required: true
- label: This request is specific to Dark Mode by GracePress.
required: true
+20
View File
@@ -0,0 +1,20 @@
## Purpose
Describe the problem and the focused change that addresses it.
## Related issue
Link the issue this pull request addresses.
## Behavior changed
Explain visible behavior, settings, stored options, compatibility rules, or documentation affected.
## Checklist
- [ ] The change is focused and does not include unrelated formatting or generated ZIP files.
- [ ] Existing settings and option keys are preserved, or a deliberate migration is documented.
- [ ] Input handling, capabilities, nonces, sanitization, escaping, accessibility, and internationalization were considered.
- [ ] No telemetry, advertising, license enforcement, remote executable code, secrets, or private data were added.
- [ ] Documentation and the changelog were updated when behavior changed.
- [ ] The change was tested on the public site, WordPress administration, or both as applicable.