Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 31 additions & 33 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,46 @@
# Contribution Guidelines

Before filing a bug report or a feature request, be sure to read the contribution guidelines.
Thanks for your interest in improving Comment Experience.

## How to use GitHub
We use GitHub exclusively for well-documented bugs, feature requests and code contributions. Communication is always done in English.
## Support, bugs, and feature requests

To receive free support for this plugin, go to [the support formus](https://wordpress.org/support/plugin/yoast-comment-hacks/). Thanks for your understanding.
We use GitHub for well-documented bug reports, feature requests, and code contributions. Communication is in English.

## Security issues
Please do not report security issues here. Instead, report them per our [security policy](https://github.com/emilia-capital/comment-hacks/security/policy).
- For plugin support, use the [WordPress.org support forum](https://wordpress.org/support/plugin/yoast-comment-hacks/).
- For security issues, follow our [security policy](https://github.com/ProgressPlanner/comment-hacks/security/policy).
- Before opening an issue, please search existing issues first.

## I have found a bug
Before opening a new issue, please:
* update to the newest versions of WordPress, Yoast SEO and the PDF XML sitemap plugins.
* search for duplicate issues to prevent opening a duplicate issue. If there is already an open existing issue, please comment on that issue.
* follow our _New issue_ template when creating a new issue.
* add as much information as possible. For example: add screenshots, relevant links, step by step guides etc.
## Reporting a bug

## I have a feature request
Before opening a new issue, please:
* search for duplicate issues to prevent opening a duplicate feature request. If there is already an open existing request, please leave a comment there.
* add as much information as possible. For example: give us a clear explanation of why you think the feature request is something we should consider for the plugin.
Before opening a bug report, please:

## I want to create a patch
Community made patches, localizations, bug reports and contributions are very welcome and help us tremendously.
- Update WordPress and the plugin to the latest available versions.
- Check whether the issue has already been reported.
- Follow the issue template and include clear reproduction steps.
- Add screenshots, relevant links, logs, or other context where helpful.

When contributing please ensure you follow the guidelines below so that we can keep on top of things.
If you still need to report a bug, [open an issue](https://github.com/ProgressPlanner/comment-hacks/issues/new/choose).

#### Submitting an issue you found
Make sure your problem does not exist as a ticket already by searching through [the existing issues](https://github.com/emilia-capital/comment-hacks/issues/). If you cannot find anything which resembles your problem, please [create a new issue](https://github.com/emilia-capital/comment-hacks/issues/new).
## Requesting a feature

#### Fixing an issue
Before opening a feature request, please:

* Fork the repository on GitHub (make sure to use the `develop` branch).
* Make the changes to your forked repository.
* Ensure you stick to the [WordPress Coding Standards](https://make.wordpress.org/core/handbook/best-practices/coding-standards/) and you properly document any new functions, actions and filters following the [documentation standards](https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/).
* When committing, reference your issue and include a note about the fix.
* Push the changes to your fork and submit a pull request to the `develop` branch of the Accessibility Checker repository.
- Check whether the idea has already been suggested.
- Explain the problem you are trying to solve.
- Share enough context for us to understand the use case and expected outcome.

We will review your pull request and merge when everything is in order. We will help you to make sure the code complies with the standards described above.
## Submitting a patch

#### 'Patch welcome' issues
Some issues are labeled 'patch-welcome'. This means we see the value in the particular enhancement being suggested but have decided for now not to prioritize it. If you however decide to write a patch for it, we'll gladly include it after some code review.
Community contributions are welcome.

#### Additional Resources
* [General GitHub Documentation](https://help.github.com/)
* [GitHub Pull Request documentation](https://help.github.com/send-pull-requests/)
1. Fork the repository.
2. Create a branch for your change.
3. Make your update.
4. Follow the [WordPress Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/) and relevant inline documentation standards.
5. Run the relevant checks before submitting.
6. Open a pull request against the default branch used by this repository.

## Additional resources

- [GitHub documentation](https://docs.github.com/)
- [Pull request documentation](https://docs.github.com/pull-requests)
20 changes: 10 additions & 10 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@

## Reporting a Vulnerability

You can report any security bugs found in the source code of this plugin through the [Patchstack Vulnerability Disclosure Program](https://patchstack.com/database/vdp/yoast-comment-hacks). The Patchstack team will assist you with verification, CVE assignment and take care of notifying the developers of this plugin.
Please report security issues through the [Patchstack Vulnerability Disclosure Program](https://patchstack.com/database/vdp/comment-hacks). Patchstack helps with verification, coordinated disclosure, and notifying the maintainers.

## Responding to Vulnerability Reports

I take security bugs very seriously. I appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions. Patchstack will work with you and me to deal with the security issue as best as possible.
We take security reports seriously and appreciate responsible disclosure. We aim to confirm, assess, and address valid reports as quickly as possible.

## Disclosing a Vulnerability
## Disclosure Process

Once an issue is reported, I will use the following disclosure process:
When a report is received, we use the following process:

- When a report is received, I confirm the issue and determine its severity together with Patchstack.
- If we know of specific third-party services or software that require mitigation before publication, those projects will be notified.
- An advisory is prepared (but not published) which details the problem and steps for mitigation.
- Patch releases are published and the advisory is published.
- Release notes and our readme.txt will include a `Security` section with a link to the advisory.
- Confirm the issue and determine severity together with Patchstack.
- Notify affected third parties if coordinated mitigation is needed before disclosure.
- Prepare an advisory with details and mitigation guidance.
- Publish a patch release.
- Publish the advisory once fixes are available.

We credit reporters for identifying vulnerabilities, although we will keep your name confidential if you request it.
We credit reporters for identifying vulnerabilities unless they request to remain anonymous.
21 changes: 0 additions & 21 deletions SECURITY.md

This file was deleted.

86 changes: 61 additions & 25 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,36 +9,72 @@
[![Lint](https://github.com/ProgressPlanner/comment-hacks/actions/workflows/lint.yml/badge.svg)](https://github.com/ProgressPlanner/comment-hacks/actions/workflows/lint.yml)
[![Test](https://github.com/ProgressPlanner/comment-hacks/actions/workflows/test.yml/badge.svg)](https://github.com/ProgressPlanner/comment-hacks/actions/workflows/test.yml)

![Comment Experience banner](.wordpress-org/github_banner_comment_experience_pp.png)

# Comment Experience

Improve the comment experience on your site. Adds lots of features to make commenting easier and more engaging.
Make WordPress comments easier to manage with cleaner moderation emails, better routing, comment policy controls, length limits, and tools for following up with commenters.

## Why this plugin exists

Core WordPress comments work, but moderation and follow-up can feel clunky. Comment Experience adds practical improvements for site owners and editors who want a cleaner, more manageable comment workflow without replacing the native comments system.

## What it helps you do

- Clean up comment notification emails so moderation is easier.
- Require acceptance of a comment policy before submission.
- Forward comments to another email address and optionally trash them.
- Set minimum and maximum comment lengths.
- Redirect first-time commenters to a thank-you page.
- Change a comment's parent ID from the comment edit screen.
- Email an individual commenter from the comments screen.
- Email all commenters on a post from the admin bar.
- Route comment emails to another user from a post's discussion settings.

## Description
## Installation

This plugin adds many small improvements around core WordPress comments to make them more bearable:
### From WordPress admin

* Cleaner comment notification emails.
* The option to enforce a comment policy.
* The option to forward comments to an email address (for instance for your support team) and then trash them.
* The option to disallow comments below a certain length.
* The option to redirect first time commenters to a "thank you" page.
* An input field on the comment edit screen to change the comment parent ID.
* Links in the admin comments section to email individual commenters.
* A button in the WP toolbar to email all the commenters on a post.
1. In your WordPress dashboard, go to **Plugins → Add New**.
2. Search for **Comment Experience** or **comment hacks**.
3. Install and activate the plugin.
4. Go to **Settings → Comment Experience** to configure the available options.

### Manual installation

1. Download the plugin zip.
2. Upload the `comment-hacks` folder to `/wp-content/plugins/`.
3. Activate the plugin in **Plugins**.
4. Go to **Settings → Comment Experience** to configure the available options.

## Screenshots

Screenshot of a clean comment notification email:<br>
![Screenshot of a clean comment notification email](.wordpress-org/screenshot-1.png)<br>
<br>
The comment parent edit box:<br>
![The comment parent edit box](.wordpress-org/screenshot-2.png)<br>
<br>
The plugins admin settings:<br>
![The plugins admin settings](.wordpress-org/screenshot-3.png)<br>
<br>
The button on the frontend to email all the commenters on a post:<br>
![The button to email all commenters](.wordpress-org/screenshot-4.png)<br>
<br>
The link in the backend to email an individual commenters on a post:<br>
![The button to email all commenters](.wordpress-org/screenshot-5.png)<br><br>
### Cleaner comment notification emails
![Cleaner comment notification emails](.wordpress-org/screenshot-1.png)

### Edit a comment's parent directly from the comment screen
![Edit a comment's parent directly from the comment screen](.wordpress-org/screenshot-2.png)

### Configure comment length, policy, redirects, email links, and forwarding from one settings screen
![Configure comment settings](.wordpress-org/screenshot-3.png)

### Email all commenters on a post from the WordPress admin bar
![Email all commenters on a post from the WordPress admin bar](.wordpress-org/screenshot-4.png)

### Contact an individual commenter from the comments list table
![Contact an individual commenter from the comments list table](.wordpress-org/screenshot-5.png)

## Support, issues, and security

- Questions or support: [WordPress.org support forum](https://wordpress.org/support/plugin/yoast-comment-hacks/)
- Bug reports and feature requests: [GitHub issues](https://github.com/ProgressPlanner/comment-hacks/issues)
- Security reports: [Patchstack VDP](https://patchstack.com/database/vdp/comment-hacks)

## Contributing

Contributions are welcome. Please read [`.github/CONTRIBUTING.md`](.github/CONTRIBUTING.md) before opening an issue or pull request.

## Links

- [Plugin page on WordPress.org](https://wordpress.org/plugins/yoast-comment-hacks/)
- [Progress Planner](https://progressplanner.com/)
Loading
Loading