Skip to content

Commit ea74bd3

Browse files
authored
Merge pull request #9014 from McSinyx/docs-news-rst
Update docs for less common news extension
2 parents cffc3a6 + 279e735 commit ea74bd3

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

docs/html/development/contributing.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -109,22 +109,22 @@ A trivial change is anything that does not warrant an entry in the news file.
109109
Some examples are: Code refactors that don't change anything as far as the
110110
public is concerned, typo fixes, white space modification, etc. To mark a PR
111111
as trivial a contributor simply needs to add a randomly named, empty file to
112-
the ``news/`` directory with the extension of ``.trivial``. If you are on a
112+
the ``news/`` directory with the extension of ``.trivial.rst``. If you are on a
113113
POSIX like operating system, one can be added by running
114-
``touch news/$(uuidgen).trivial``. On Windows, the same result can be achieved
115-
in Powershell using ``New-Item "news/$([guid]::NewGuid()).trivial"``. Core
116-
committers may also add a "trivial" label to the PR which will accomplish the
117-
same thing.
114+
``touch news/$(uuidgen).trivial.rst``. On Windows, the same result can be
115+
achieved in Powershell using ``New-Item "news/$([guid]::NewGuid()).trivial"``.
116+
Core committers may also add a "trivial" label to the PR which will accomplish
117+
the same thing.
118118

119119
Upgrading, removing, or adding a new vendored library gets a special mention
120-
using a ``news/<library>.vendor`` file. This is in addition to any features,
120+
using a ``news/<library>.vendor.rst`` file. This is in addition to any features,
121121
bugfixes, or other kinds of news that pulling in this library may have. This
122122
uses the library name as the key so that updating the same library twice doesn't
123123
produce two news file entries.
124124

125125
Changes to the processes, policies, or other non code related changed that are
126-
otherwise notable can be done using a ``news/<name>.process`` file. This is not
127-
typically used, but can be used for things like changing version schemes,
126+
otherwise notable can be done using a ``news/<name>.process.rst`` file. This is
127+
not typically used, but can be used for things like changing version schemes,
128128
updating deprecation policy, etc.
129129

130130

news/e1831861-84a4-4f9b-9987-762e127cb42b.trivial.rst

Whitespace-only changes.

0 commit comments

Comments
 (0)