Feature request: Require punctuation at the end of each note

[dsmithpadilla]

Is there an easy way to require punctuation at the end of each note during a Save or Create action?

Why? We are trying to unify how relnotes are written and would like to require at-least a period at the end of each note.

What? It is important to note that it would be the note preview that matters rather than the note text, since there is a case in which the note ends with a url as depicted below.

A simple message such as "Punctuation is required on this note" would be ideal after the save/create button is clicked and the requirement is not met.

Urgency? This shouldn't take priority over anything else, and would be okay without it if the level of effort is too high.

[stevejalim]

@dsmithpadilla Is a full stop / period the only character you are going to need, or would a question mark also be useful? Also, are release notes always published in en-US only? (I ask i case we need to also support "¿" etc)

[dsmithpadilla]

@stevejalim
I think either a period(.) or exclamation mark(!) are okay.
We wouldn't use a ? mark.
They are always published in English.

Thank you! Let me know if you need any other clarification.

[stevejalim]

Thanks @dsmithpadilla that's great - will make the allowlist . and ! for now

[stevejalim]

Hi @dsmithpadilla - this is now deployed to prod. Let us know if there are any edge cases that need extra tweaks, or any other feature requests you have.

[dsmithpadilla]

Just tested this and works really well! thank you! I tested new ones, editing them, as well as editing existing ones.

The only edge case I found was if the note ends in a screenshot. In the case displayed below the note ends in a (.) but because there is a screenshot, it is reading the ending with a closed ']' an throwing the error message. I think adding [] as acceptable would be a good tweak (but not adding that to the error message]

.

[stevejalim]

@dsmithpadilla Heya - OK pushed a fix for the image edge case. If it's all OK with you now, please do close this ticket. 👍

[pascalchevrel]

Hi, this change prevents creating a markdown list such as:

Major improvements of our WebRTC capabilities (libwebrtc library upgraded from version 86 to 103) with multiple improvements:

* Many RTP performance and reliability improvements. 
* Windows and Wayland screen sharing improvements. 
* Richer statistics.

The blank line before the list items is necessary for it to be valid markdown but then I can't publish the note.

Is this new rule making the assumption that all release notes are one-liners?

I think this new rule should be informative and we should be able to bypass the restriction if we want to. I remember in the past having a couple of notes ending with … btw.