Add public issue and contribution guidance
This commit is contained in:
@@ -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
|
||||||
@@ -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
|
||||||
@@ -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.
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
# Contributing to Dark Mode by GracePress
|
||||||
|
|
||||||
|
Thank you for helping improve Dark Mode by GracePress.
|
||||||
|
|
||||||
|
## Before opening an issue
|
||||||
|
|
||||||
|
- Search existing issues for the same behavior.
|
||||||
|
- Confirm the problem still occurs with the current public-development source.
|
||||||
|
- Collect the plugin, WordPress, PHP, browser, and theme versions involved.
|
||||||
|
- Remove passwords, tokens, private URLs, customer information, and other secrets from screenshots and logs.
|
||||||
|
- Use the security process in SECURITY.md for vulnerabilities.
|
||||||
|
|
||||||
|
## Bug reports
|
||||||
|
|
||||||
|
Use the Bug Report form in Gitea Issues. Include exact reproduction steps, what you expected, what occurred, and whether the problem affects the public site, WordPress administration, or both.
|
||||||
|
|
||||||
|
## Feature requests
|
||||||
|
|
||||||
|
Use the Feature Request form. Explain the user problem first. Dark Mode is intentionally complete and focused, so additions must fit the existing purpose without introducing paywalls, telemetry, required remote services, or unnecessary administration notices.
|
||||||
|
|
||||||
|
## Pull requests
|
||||||
|
|
||||||
|
- Open or reference an issue before beginning a substantial change.
|
||||||
|
- Keep changes focused on one problem.
|
||||||
|
- Preserve existing settings, option keys, and compatibility behavior unless the change explicitly includes a migration.
|
||||||
|
- Follow WordPress coding, security, escaping, sanitization, nonce, capability, accessibility, and internationalization conventions.
|
||||||
|
- Do not add bundled duplicate WordPress libraries, remote executable code, telemetry, advertising, or license enforcement.
|
||||||
|
- Update documentation and the changelog when behavior changes.
|
||||||
|
- Do not include generated installation ZIP files, credentials, private data, or unrelated formatting changes.
|
||||||
|
|
||||||
|
Pull requests are reviewed before merge. Submission does not guarantee acceptance.
|
||||||
|
|
||||||
|
## Development source and releases
|
||||||
|
|
||||||
|
This Git repository is the public development source. A Git tag records a source milestone. A formal Gitea or WordPress.org release is created only when a version is deliberately approved for public installation.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
By contributing, you agree that your contribution may be distributed under GPL-2.0-or-later with the rest of the plugin.
|
||||||
@@ -1,20 +1,31 @@
|
|||||||
# Dark Mode by GracePress
|
# Dark Mode by GracePress
|
||||||
|
|
||||||
A configurable dark mode for WordPress websites and the WordPress administration area.
|
A complete, configurable dark mode for WordPress websites and the WordPress administration area.
|
||||||
|
|
||||||
|
| Project information | Current state |
|
||||||
|
| --- | --- |
|
||||||
|
| Current source version | **4.8.18** |
|
||||||
|
| Public release status | **Preparing for WordPress.org** |
|
||||||
|
| First supported public release | **5.0.0 (planned)** |
|
||||||
|
| License | **GPL-2.0-or-later** |
|
||||||
|
| Telemetry | **None** |
|
||||||
|
| Account or subscription required | **No** |
|
||||||
|
|
||||||
Dark Mode by GracePress includes anti-flash loading, operating-system preference support, visual tuning, media correction, transitions, and accessible controls that can be placed where a site needs them.
|
Dark Mode by GracePress includes anti-flash loading, operating-system preference support, visual tuning, media correction, transitions, and accessible controls that can be placed where a site needs them.
|
||||||
|
|
||||||
## Project status
|
## Project status
|
||||||
|
|
||||||
Version 4.8.18 is the current public-development baseline. The plugin is being prepared, documented, and tested for submission to WordPress.org. Version 5.0.0 is reserved for the deliberate first WordPress.org release.
|
Version 4.8.18 is the mature public-development baseline. The plugin is being documented, reviewed, and tested for submission to WordPress.org. Version 5.0.0 is reserved for the deliberate first supported public release.
|
||||||
|
|
||||||
There is no official public download yet. Candidate packages are used only for controlled testing until the public release is approved.
|
The source is public and may be inspected, cloned, or downloaded from this repository. There is no official public installation package yet. Candidate packages remain limited to controlled testing until the public release is ready.
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
- [Public plugin page](https://christit.com/gracepress/plugins/dark-mode-by-gracepress/)
|
- [Public plugin page](https://christit.com/gracepress/plugins/dark-mode-by-gracepress/)
|
||||||
- [GracePress project](https://christit.com/gracepress/)
|
- [GracePress project](https://christit.com/gracepress/)
|
||||||
- [GracePress plugin catalog](https://christit.com/gracepress/plugins/)
|
- [GracePress plugin catalog](https://christit.com/gracepress/plugins/)
|
||||||
|
- [Issue tracker](https://git.christit.com/gracepress/dark-mode-by-gracepress/issues)
|
||||||
|
- [Version history](CHANGELOG.md)
|
||||||
- [Christ IT](https://christit.com/)
|
- [Christ IT](https://christit.com/)
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
@@ -41,10 +52,24 @@ GracePress Central Hub routing and OmniLog events are optional local integration
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
The official installation route will be published here and on the public plugin page after the WordPress.org release is approved. See `readme.txt` for the current controlled-testing instructions and WordPress plugin documentation.
|
The official installation route will be published here and on the public plugin page after the WordPress.org release is ready. See readme.txt for WordPress plugin documentation.
|
||||||
|
|
||||||
|
## Reporting problems
|
||||||
|
|
||||||
|
Use the [Gitea Issues page](https://git.christit.com/gracepress/dark-mode-by-gracepress/issues) for reproducible bugs, compatibility reports, and feature requests. A free Git account is required to submit an issue. Read [SUPPORT.md](SUPPORT.md) before reporting a problem.
|
||||||
|
|
||||||
|
Do not disclose security vulnerabilities in a public issue. Follow [SECURITY.md](SECURITY.md) instead.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Public contributions are welcome through issues and pull requests. Read [CONTRIBUTING.md](CONTRIBUTING.md) before proposing a change.
|
||||||
|
|
||||||
|
## Historical versions
|
||||||
|
|
||||||
|
The changelog preserves the established GracePress development history, including conservative reconstructed entries for versions recovered from archived packages and rollback copies. Versions before 5.0.0 were internal development iterations and are not represented as supported public releases.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Dark Mode by GracePress is licensed under [GPL-2.0-or-later](LICENSE.txt).
|
Dark Mode by GracePress is licensed under [GPL-2.0-or-later](LICENSE.txt).
|
||||||
|
|
||||||
Published by Jason Eugene Garrison through [Christ IT](https://christit.com/). Questions may be sent to [jason@christit.com](mailto:jason@christit.com).
|
Published by Jason Eugene Garrison through [Christ IT](https://christit.com/). General questions may be sent to [jason@christit.com](mailto:jason@christit.com).
|
||||||
|
|||||||
+19
@@ -0,0 +1,19 @@
|
|||||||
|
# Security Policy
|
||||||
|
|
||||||
|
## Reporting a vulnerability
|
||||||
|
|
||||||
|
Do not report suspected vulnerabilities through a public issue, pull request, discussion, or comment.
|
||||||
|
|
||||||
|
Email **jason@christit.com** with the subject "Dark Mode by GracePress security report".
|
||||||
|
|
||||||
|
Include the affected version, a concise description, reproduction details, potential impact, and any suggested mitigation. Do not include credentials, private keys, customer data, or unrelated private information.
|
||||||
|
|
||||||
|
You should receive an acknowledgement as soon as practical. Please allow time to investigate and prepare a correction before publishing details.
|
||||||
|
|
||||||
|
## Supported versions
|
||||||
|
|
||||||
|
Dark Mode by GracePress is currently in public-development preparation. Version 5.0.0 is planned as the first supported public release. Security reports concerning the current main branch and version 4.8.18 preparation work are still welcome.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
Reports should concern the source in this repository. GracePress Central Hub and OmniLog are separate optional projects and should be reported to their own maintainers when the issue does not originate in Dark Mode by GracePress.
|
||||||
+25
@@ -0,0 +1,25 @@
|
|||||||
|
# Support
|
||||||
|
|
||||||
|
## Current development stage
|
||||||
|
|
||||||
|
Dark Mode by GracePress is preparing for its first supported WordPress.org release. Version 4.8.18 is the public-development baseline; version 5.0.0 is planned as the first supported public release.
|
||||||
|
|
||||||
|
## Where to ask
|
||||||
|
|
||||||
|
- Reproducible bug: open a Bug Report in Gitea Issues.
|
||||||
|
- Theme, plugin, browser, PHP, or WordPress compatibility problem: open a Compatibility Report.
|
||||||
|
- Proposed improvement: open a Feature Request.
|
||||||
|
- General project question: email jason@christit.com.
|
||||||
|
- Security vulnerability: follow SECURITY.md and do not open a public issue.
|
||||||
|
|
||||||
|
A free account on git.christit.com is required to submit or comment on issues. Repository source and existing issues remain publicly readable.
|
||||||
|
|
||||||
|
## What to include
|
||||||
|
|
||||||
|
Provide the plugin version, WordPress version, PHP version, browser, active theme, relevant plugins, affected surface, reproduction steps, expected result, and actual result. Screenshots and sanitized logs are useful.
|
||||||
|
|
||||||
|
Never post passwords, authentication tokens, private keys, recovery material, non-public customer information, or private administration URLs.
|
||||||
|
|
||||||
|
## WordPress.org support
|
||||||
|
|
||||||
|
After publication, ordinary installation and usage support may also occur in the plugin's WordPress.org support forum. Confirmed code defects will continue to be tracked in Gitea Issues.
|
||||||
Reference in New Issue
Block a user