summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias Beyer <matthias.beyer@ifm.com>2022-07-17 10:18:50 +0200
committerMatthias Beyer <matthias.beyer@ifm.com>2022-08-08 08:24:42 +0200
commit167e519af8ebc7af4d7a537983e6c96fa4decc47 (patch)
treeae558d0c95602582bbe77668fd6f036daeb849ca
parent18f91167bce9e74ef929c08a4e54cb238e5ed33d (diff)
Add note that plugins should be documenteddoc/contributing-plugins-doc
Signed-off-by: Matthias Beyer <matthias.beyer@ifm.com>
-rw-r--r--docs/src/contributing-plugins.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/src/contributing-plugins.md b/docs/src/contributing-plugins.md
index 19ea8942..a3c46a01 100644
--- a/docs/src/contributing-plugins.md
+++ b/docs/src/contributing-plugins.md
@@ -26,10 +26,15 @@ have to follow these steps:
* Create your plugin on a new branch in the `/plugins` folder, using
`cargo new --lib`
+* Create a documentation folder for your plugin, named as the plugin, under
+ `/docs/src/plugins/<your plugin name>`.
+ You can use the template from `/docs/src/plugins/000_template.md` to get
+ started.
* Implement your plugin and your business case
* Make sure that the code builds cleanly, to follow the coding styleguide
(`cargo fmt`), that there are no clippy warnings or errors, etc. Structure
- your code cleanly. Do not use unsafe code, if possible
+ your code cleanly. Do not use unsafe code, if possible.
+ Add appropriate documentation.
* If your development takes a long time, make sure to rebase your branch
frequently. If that is not possible, because a whole team is working on the
plugin and you have to merge forwards and backwards within your team, feel