Skip to content

Commit 90a5094

Browse files
Add section to contributing guide about adding notes for new features or changes
1 parent d40e8e2 commit 90a5094

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -314,6 +314,37 @@ that a link will remain valid, add a custom anchor to the section title:
314314
(note the space after the opening brace). You can then refer to it within
315315
another markdown file with `[Some section][permanent-anchor-to-some-section]`.
316316

317+
### Adding notes about new features or changes
318+
319+
We use the admonition extension of
320+
[Mkdocs Material](https://squidfunk.github.io/mkdocs-material/reference/admonitions/)
321+
to create admonitions, also known as call-outs, that hold information
322+
about when a certain feature was added or changed and optionally
323+
some description of the change. We put the admonition directly
324+
in a module's, a function's or class' docstring.
325+
326+
For a new feature, we use the following admonition:
327+
328+
```
329+
!!! tip "New in version <Version Number>"
330+
```
331+
332+
For a change to an existing feature we use instead:
333+
334+
```
335+
!!! tip "Changed in version <Version Number>"
336+
337+
<Description>
338+
```
339+
340+
For example, for a change in version `1.2.3` that adds kwargs
341+
to a class' constructor we would write:
342+
343+
```
344+
!!! tip "Changed in version 1.2.3"
345+
346+
Added kwargs to the constructor.
347+
```
317348

318349
### Using bibliography
319350

0 commit comments

Comments
 (0)