This task about is implementing a way for people to customize the edit summaries that accompany comments (read: edits) posted with the Reply tool.
=== Background
Currently, the Reply tool automatically generates the edit summary that accompanies comments posted using it.
Some people have requested [1][2][3] support be added to the tool that would enable them to customize the edit summaries for comments they post using the Reply tool. This way, people monitoring the conversation (e.g. via their Watchlist, email notifications, page history, etc.) can more easily decide whether an edit is needing of their attention.
=== Requirements
- The ability to customize the edit summaries should not be prominent in the tool's UI; it should be a feature that is visible and accessible to those seeking it out. //Said another way: the ability to customize an edit summary should not catch the attention of someone who is not looking for it.//Meta
- People writing a comment with the Reply tool should not be led to wonder or think about whether a custom edit summary is required.- The ability to customize the edit summaries should not be prominent in the tool's UI; it should be a feature that is visible and accessible to those seeking it out. //Said another way: the ability to customize an edit summary should not catch the attention of someone who is not looking for it.//
- The tool should continue to feel "lightweight" regardless of whether someone decides to customize the edit summary of the comment they are writing.
=== Approaches- People writing a comment with the Reply tool should not be led to wonder or think about whether a custom edit summary is required.
**Approach 1: expose "Edit Summaries" via an Advanced Mode**-- The tool should continue to feel "lightweight" regardless of whether someone decides to customize the edit summary of the comment they are writing. //E.g. it would be undesirable to introduce the custom edit summary as an additional required "step" in the posting flow.//
# For people to enable custom edit summaries in the Reply tool, they would turn on a preference within `Special:Preferences > Editing` [i][ii]- Tactical
# After enabling said "preference," people would see an additional call to action of some kind (e.g. a link, button, checkbox-- Within the Reply Tool, etc.) within the Reply toolSenior Contributors should be able to easily know how to customize the edit summary that will accompany the comment they are posting
# When people engaged (read: click) that "call to action" they would see a one-line edit summary text field--- //This is not to say the custom edit summary field needs to be exposed by default, but rather that Senior Contributors need to be able to easily show/hide the custom edit summary field/functionality in context (read: without having to navigate away from the comment they are writing to a separate page, like Special:Preferences).//
-- Said "text field" would be pre-populated with the automatic edit summary which people could in turn changeJunior Contributors should not become distracted by the custom edit summary functionality nor should they feel an obligation to engage with it.
# After changing the edit summary text within the one-line edit summary text fiel-- People should be able to customize the edit summary for the comment they are writing in the tool's `visual` and `source` mode.
-- The custom edit summary field should be pre-populated with the automatic summary that, if unchanged, they would click the tool's pre-existing "Reply" button to publish the comment they wrote which would be accompanied by the custom edit summary they composedwould be posted with the comment they are writing.
**Approach 2: expose "Edit Summaries" be default**=== Implementation details
# For people to enable custom edit summaries in the Reply tool, they would interact with a call to action of some kind (e.g.To start, a link, button, checkboxwe will implement an approach that most closely resembles **Approach 2: expose "Edit Summaries" //inside// the tool.**
This means, etc.) that is present within the Reply tool's UI by default
# When someone engaged with (read: clicked) said "call to action," they would see a one-line edit summary text field//all// of the actions people need to take to customize their edit summary will happen //within// the Reply Tool.
=== Open questions
-- Said "text field" would be pre-populated with- [x] 1. What should the "edit summary" be called in the automatic edit summary which people could in turn changecontext of the Reply tool? //Context: T241403.//
# After changing the edit summary text within the one-line edit summary text field, they would click the tool's pre-existing "Reply" button to publish the comment they wrote which would be accompanied by the custom edit summary they composed.
=== Open questions-- "Edit summary" is fine in this context considering it is unlikely Junior Contributors (read: the people most likely to be confused by the non-discussion specific language) will be engaging with this part of the tool.
- [ ] 1~~2A. What should the "edit summary" be called in the context of the Reply tool?If **Approach #1** is implemented, //Context: T241403.//where should the preference it requires be located?~~
-- Thought: "edit summary" is fine in this context considering it is unlikely Junior Contributors (read: the people most likely to be confused by the non-discussion specific language) will be engaging with this part of the toolWe will not be trying Approach #1 to start.
- [ ] 2A~~2B. If **Approach #1** is implemented, where should the preference it requires be located?called?~~
- [ ] 2B.- We will not be trying Approach #1 to start.
- [ ] 3. In what – if any – cases should the custom edit summary field/functionality be exposed/turned on for people when using the Reply Tool for the first time?
-- Idea prompted by @Geraki: people who have the `Prompt me when entering a blank edit summary (or the default undo summary)` [Special:Preferences](https://en.wikipedia.org/wiki/Special:Preferences) enabled should see the custom edit summary field/functionality automatically.
- [ ] 4. How should the affordance to expose/enable custom edit summaries be presented? Should it exist within a "Settings" interface/modal that people can interact with in the context of the tool as is done in Convenient Discussions [4]? Should it have an explicit affordance, If **Approach #1** is implemented,like what @Marc is proposing [5][6]?
- [ ] 5. where should the preference it requires be called?Should the tool be able to "remember" whether people have used the custom edit summary functionality in the past?
=== Done
- [ - [x] An "Approach" that meets the "Requirements" above is decided upon
-- We will start by experimenting with an approach that most closely resembles
- [ ] The chosen "Approach" is implemented
---
1. https://hu.wikipedia.org/w/index.php?title=Wikip%C3%A9dia%3AKonzult%C3%A1ci%C3%B3_a_vitalapokr%C3%B3l_%C3%A9s_a_k%C3%B6z%C3%B6ss%C3%A9gi_kommunik%C3%A1ci%C3%B3r%C3%B3l&type=revision&diff=22425243
2. T249072#6021222
3. https://nl.wikipedia.org/wiki/Wikipedia:Discussietools
4. {F31945082}
5. {F31937808}
6. {F31939056}
---
=== Approaches
**Approach 1: expose "Edit Summaries" //outside// the tool**
# For people to enable custom edit summaries in the Reply tool, they would turn on a preference within `Special:Preferences > Editing` [i][ii]
# After enabling said "preference," people would see an additional call to action of some kind (e.g. a link, button, checkbox, etc.) within the Reply tool
# When people engaged (read: click) that "call to action" they would see a one-line edit summary text field
-- Said "text field" would be pre-populated with the automatic edit summary which people could in turn change
# After changing the edit summary text within the one-line edit summary text field, they would click the tool's pre-existing "Reply" button to publish the comment they wrote which would be accompanied by the custom edit summary they composed.
**Approach 2: expose "Edit Summaries" //inside// the tool**
# For people to enable custom edit summaries in the Reply tool, they would interact with a call to action of some kind (e.g. a link, button, checkbox, etc.) that is present within the Reply tool's UI by default
# When someone engaged with (read: clicked) said "call to action," they would see a one-line edit summary text field
-- Said "text field" would be pre-populated with the automatic edit summary which people could in turn change
# After changing the edit summary text within the one-line edit summary text field, they would click the tool's pre-existing "Reply" button to publish the comment they wrote which would be accompanied by the custom edit summary they composed.