Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

spec: Expand documentation for <issue> elements #463

Merged
merged 4 commits into from Feb 3, 2023
Merged

spec: Expand documentation for <issue> elements #463

merged 4 commits into from Feb 3, 2023
+36 −5

Commits on Feb 2, 2023

  1. spec: Fix a trailing comma at the end of a paragraph 

    Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
    @pwithnall
    pwithnall committed Feb 2, 2023
    5b5ca99

  2. spec: Expand documentation for <issue> elements 

    Try and make it a bit clearer what formats are expected, and when URLs
are expected to be given. What was there before was not incorrect, but
was a bit hard to unpack.

Add a couple more examples inline.

Signed-off-by: Philip Withnall <pwithnall@endlessos.org>

Fixes: ximion#458
    @pwithnall
    pwithnall committed Feb 2, 2023
    565bace

  3. spec: Mention that <issues> is not part of the description 

    Given that it’s typically written right after the `<description>`
element, there’s a temptation to think that it will be presented right
after the prose in the description. But that’s not necessarily the case.

Signed-off-by: Philip Withnall <pwithnall@endlessos.org>

Helps: ximion#458
    @pwithnall
    pwithnall committed Feb 2, 2023
    a1d3fd1

  4. spec: Give some guidance about tone in release descriptions 

    Signed-off-by: Philip Withnall <pwithnall@endlessos.org>

Helps: ximion#458
    @pwithnall
    pwithnall committed Feb 2, 2023
    531dd14