Require Edit Reason

Theme component
1

The purpose of this component is to encourage users to add edit reasons when they edit a post. Edit reasons are displayed at the top of a post’s edit history modal and are a great way to understand why something within a post was changed. This might be especially useful for users that are able to edit other users’ posts as it will help to avoid any “why did you edit my post?!” responses.

How it Works

When someone opens the composer to edit, the edit reason field is exposed and marked required. The save button is disabled until the reason is added.

The image shows a text editor with partially written text and added text in red, indicating that the user is currently editing. (Captioned by AI)
The image shows a text editor with partially written text and added text in red, indicating that the user is currently editing. (Captioned by AI)1350×1028 71.6 KB

Once a reason is added, the edit can be saved

The image shows a keyboard and mouse screenshot with a text caption edited with a "spelling fix" chapter title, featuring a page number, text highlighted for emphasis, and missing words. (Captioned by AI)
The image shows a keyboard and mouse screenshot with a text caption edited with a "spelling fix" chapter title, featuring a page number, text highlighted for emphasis, and missing words. (Captioned by AI)1186×952 58.2 KB

Configurable Settings

The image shows a configuration setting for requiring contributors to provide an edit reason, with a trust level of 0, and a 0-minute grace period for editing without a reason. (Captioned by AI)
The image shows a configuration setting for requiring contributors to provide an edit reason, with a trust level of 0, and a 0-minute grace period for editing without a reason. (Captioned by AI)1496×424 20 KB

:star: Pro-tip: If you want to require all users to add edit reasons, simply add the trust_level_0 group to the “edit reason required groups” theme setting.

Installation

Repository Link
https://github.com/discourse/discourse-require-edit-reason

If you are unfamiliar with theme components and how to install them, check out the theme installation guide . And if you’d like to learn more about Discourse themes, take a look at this guide .

37 Likes