diff --git a/static/css/cover.css b/static/css/cover.css index 74ce96f..e22104f 100644 --- a/static/css/cover.css +++ b/static/css/cover.css @@ -5,3 +5,19 @@ .narrow { max-width: 40rem; } + +/* The NEWS entry guide: an accordion in the theme's info colours. */ +.accordion-info { + --bs-accordion-color: var(--bs-info-text-emphasis); + --bs-accordion-bg: var(--bs-info-bg-subtle); + --bs-accordion-border-color: var(--bs-info-border-subtle); + --bs-accordion-btn-color: var(--bs-info-text-emphasis); + --bs-accordion-btn-bg: var(--bs-info-bg-subtle); + --bs-accordion-active-color: var(--bs-info-text-emphasis); + --bs-accordion-active-bg: var(--bs-info-border-subtle); + --bs-accordion-btn-focus-box-shadow: 0 0 0 0.25rem rgba(var(--bs-info-rgb), 0.25); +} + +.accordion-info .accordion-button { + font-weight: 600; +} diff --git a/templates/add_blurb.html b/templates/add_blurb.html index 1647e9d..410bd1f 100644 --- a/templates/add_blurb.html +++ b/templates/add_blurb.html @@ -58,11 +58,34 @@

Add a NEWS entry

Optional. The CVE identifier (CVE-YYYY-NNNN) for this security fix.
+
+
+
+

+ +

+
+
+

The entry becomes part of the changelog, whose readers are mainly users, not core developers. Most of them will not open the issue or the diff, so the entry must stand alone. Keep it to one or two sentences.

+
    +
  • Start with a verb in the imperative mood that says what kind of change it is: Fix, Add, Remove, Deprecate, Allow, Raise.
  • +
  • Name what changed using inline markup such as :func:, :class: or :mod:, so readers can jump to the documentation.
  • +
  • Say what a user will notice, and under what conditions. Then stop.
  • +
  • Leave out implementation details, how the problem was found, tests that were added, and phrases such as "this PR".
  • +
  • Write valid reStructuredText with no leading - and no issue number, which is already part of the file name.
  • +
  • Attribution is optional and goes in a final sentence of the form Patch by Jane Doe.
  • +
+

Example:
Fix :class:`logging.handlers.TimedRotatingFileHandler` permanently stopping rollover after a rollover failed or its backup file already existed, for example at a DST change.

+

See How to write a NEWS entry in the devguide for the full guidance and more examples.

+
+
+
+
+
- + +
One or two sentences of reStructuredText. See the guide above.
@@ -71,7 +94,7 @@

Add a NEWS entry

-

Alternatively, you can use blurb on the command line.

+

Alternatively, you can use blurb on the command line.

@@ -96,4 +119,30 @@

Add a NEWS entry

})(); + + {% endblock %}