{"id":29150132,"url":"https://github.com/humanmade/simple-editorial-comments","last_synced_at":"2025-06-30T23:09:39.777Z","repository":{"id":140832450,"uuid":"454481572","full_name":"humanmade/simple-editorial-comments","owner":"humanmade","description":"A lightweight editorial WordPress block allowing editors to leave comments that do not render on the frontend","archived":false,"fork":false,"pushed_at":"2024-11-12T14:24:56.000Z","size":130,"stargazers_count":12,"open_issues_count":0,"forks_count":2,"subscribers_count":18,"default_branch":"main","last_synced_at":"2025-06-30T16:14:54.115Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/humanmade.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-02-01T17:22:55.000Z","updated_at":"2025-02-21T19:11:28.000Z","dependencies_parsed_at":"2023-12-05T23:36:56.483Z","dependency_job_id":null,"html_url":"https://github.com/humanmade/simple-editorial-comments","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/humanmade/simple-editorial-comments","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/humanmade%2Fsimple-editorial-comments","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/humanmade%2Fsimple-editorial-comments/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/humanmade%2Fsimple-editorial-comments/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/humanmade%2Fsimple-editorial-comments/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/humanmade","download_url":"https://codeload.github.com/humanmade/simple-editorial-comments/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/humanmade%2Fsimple-editorial-comments/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262864258,"owners_count":23376461,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-30T23:09:39.082Z","updated_at":"2025-06-30T23:09:39.756Z","avatar_url":"https://github.com/humanmade.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Simple Editorial Comments\n\n## User Guide\n\nThis simple plugin provides blocks for editorial comments and discussion. It is simplistic by design, and not intended as an in-depth conversation or approval mechanism.\n\n### Editorial Comment block\n\nThe main block provided by this plugin is an Editorial Comment block, which permits authors and editors to leave notes in a post or page that will not render on the site frontend. They can be used to flag issues, leave thoughts for follow-ups, or for whatever purpose serves your team.\n\nTo insert an Editorial Comment block, either use the block inserter in the upper-left, or type `/editorial comment` to select and insert the block.\n\n\u003e ![screenshot of both editorial comment block insertion options](docs/insert-editorial-comment.png)\n\nOnce inserted, it will look like this:\n\n\u003e ![screenshot of freshly-inserted comment block](docs/editorial-comment.png)\n\nYou may click on and edit the block text to leave detailed feedback:\n\n\u003e ![screenshot of filled-in comment block](docs/editorial-comment-filled-in.png)\n\n### Hidden Group block\n\nThis plugin also provides a Hidden Group block. This block is intended to permit editors to flag whole sections of content for review, and to prevent them from being viewed publicly until any issues are addressed.\n\nA Hidden Group block can be inserted in the same fashion as the Editorial Comment block, but it is more common to want to hide an existing group or collection of blocks.\n\nTo create a hidden group, select one or more blocks:\n\n\u003e ![screenshot of multiple blocks selected in the editor](docs/select-blocks.png)\n\nor, select an existing group block:\n\n\u003e ![screenshot of selected group block](docs/group-block.png)\n\nthen, click on the block type icon in the upper-left of the toolbar, and select \"Hidden Group\" to wrap these blocks in a hidden group:\n\n\u003e ![screenshot of converting to a Hidden Group](docs/transform-to-hidden-group.png)\n\nTo revert a Hidden Group to a regular group, follow these same steps in reverse:\n\n\u003e ![screenshot of converting a hidden group back to a group](docs/revert-to-group.png)\n\n## Comment List sidebar\n\nA list of all comments in the current post can be expanded in the sidebar by clicking the \"pencil\" icon in the upper-right. (If this pencil icon does not appear, click the three-dot options menu and ensure that the Simple Editorial Comments menu is activated in the \"Plugins\" section.)\n\n\u003e ![screenshot of comment list sidebar](docs/sidebar.png)\n\nClick \"Select\" next to any of the comment previews to jump to that comment in the editor.\n\n## Development\n\nIf you are using [nvm](https://github.com/nvm-sh/nvm) to manage Node versions, run `nvm use` to auto-select the appropriate version of Node for this project.\n\nInstall dependencies with `npm install`.\n\nAvailable commands once installed:\n\n- `npm run build`: Generate production-ready asset bundles.\n- `npm start`: Run the hot-reloading development server.\n- `npm run lint`: Check the code for errors.\n\n## Release Process\n\n### Versioning\n\nThis plugin follows [Semantic Versioning](https://semver.org/).\n\nIn a nutshell, this means that **patch releases**, for example, 1.2.3, only contain **backwards compatible bug fixes**.\n**Minor releases**, for example, 1.2.0, may contain **enhancements, new features, tests**, and pretty much everything that **does not break backwards compatibility**.\nEvery **breaking change** to public APIs—be it renaming or even deleting structures intended for reuse, or making backwards-incompatible changes to certain functionality—warrants a **major release**, for example, 2.0.0.\n\nIf you are using Composer to pull this plugin into your website build, choose your version constraint accordingly.\n\nEven when bumping a major version, if the blocks provided by this plugin change in a backwards-incompatible way, a [block deprecation](https://developer.wordpress.org/block-editor/reference-guides/block-api/block-deprecation/) should be added to let users migrate their visualizations to the new version of the block.\n\n### Publishing a Release\n\nRelease management is done using GitHub's built-in Releases functionality. When you tag a commit on the `main` branch with a version number in the format `v#.#.#`, a release action will trigger when that tag is pushed to GitHub.\nThe GitHub actions release workflow creates a new built release based on the contents of the tag you created.\nIt copies the tag's current state to a new tag of `original/v.*.*.*`, then builds the project and pushes the built version to the original tag name `v*.*.*`.\nThis allows composer to pull in a built version of the project without the need to run webpack to use it.\n\nTo prepare a release, follow these steps:\n\n1. Ensure you are on the `main` branch and that there are no uncommitted local changes.\n2. Bump the version number in `package.json` and `plugin.php` depending on whether you are preparing a major, minor, or patch release (see [Versioning](#versioning) above).\n3. List any relevant updates, enhancements, or breaking changes in the Changelog section below.\n4. Commit this version number change and associated changelog updates, optionally specifying release notes in the commit message.\n5. Create a tag with the same number as the updated project version number, e.g. `v1.2.3`.\n6. Push the updated `main` branch and tag to GitHub.\n\nOnce a release has been created, update the release's description using GitHub's interface to add patch notes. Release notes should be high-level but complete, detailing all _New Features_, _Enhancements_, _Bug Fixes_ and potential other changes included in the according version.\n\n### Development testing\n\nAny code merged into the `develop` branch will be build and committed to the `release-develop` branch. This branch can be used in non-production applications to validate and test proposed changes.\n\n## Changelog\n\n**v1.0.0**\n\n- Update imports for WordPress 6.6 compatibility\n- Tag initial major release\n\n**v0.1.1**\n\n- Pin specific commits of 3rd party GitHub actions to ensure predictable version selection\n\n**v0.1.0**\n\n- Initial release\n- Introduce \"Editorial Comment\" block\n- Introduce \"Hidden Group\" block\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhumanmade%2Fsimple-editorial-comments","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhumanmade%2Fsimple-editorial-comments","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhumanmade%2Fsimple-editorial-comments/lists"}