diff options
| -rw-r--r-- | docs/src/contributing-plugins.md | 7 |
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 |