Add public issue and contribution guidance
This commit is contained in:
@@ -1,20 +1,31 @@
|
||||
# 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.
|
||||
|
||||
## 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
|
||||
|
||||
- [Public plugin page](https://christit.com/gracepress/plugins/dark-mode-by-gracepress/)
|
||||
- [GracePress project](https://christit.com/gracepress/)
|
||||
- [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/)
|
||||
|
||||
## Features
|
||||
@@ -41,10 +52,24 @@ GracePress Central Hub routing and OmniLog events are optional local integration
|
||||
|
||||
## 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
|
||||
|
||||
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).
|
||||
|
||||
Reference in New Issue
Block a user