From 90a509496530b4c00a04f29755c613e994122738 Mon Sep 17 00:00:00 2001 From: Anes Benmerzoug Date: Sat, 6 Apr 2024 13:47:37 +0200 Subject: [PATCH] Add section to contributing guide about adding notes for new features or changes --- CONTRIBUTING.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d2f47395f..365a5a605 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -314,6 +314,37 @@ that a link will remain valid, add a custom anchor to the section title: (note the space after the opening brace). You can then refer to it within another markdown file with `[Some section][permanent-anchor-to-some-section]`. +### Adding notes about new features or changes + +We use the admonition extension of +[Mkdocs Material](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) +to create admonitions, also known as call-outs, that hold information +about when a certain feature was added or changed and optionally +some description of the change. We put the admonition directly +in a module's, a function's or class' docstring. + +For a new feature, we use the following admonition: + +``` +!!! tip "New in version " +``` + +For a change to an existing feature we use instead: + +``` +!!! tip "Changed in version " + + +``` + +For example, for a change in version `1.2.3` that adds kwargs +to a class' constructor we would write: + +``` +!!! tip "Changed in version 1.2.3" + + Added kwargs to the constructor. +``` ### Using bibliography