wip

Author: bearomorphism

docs/third-party-plugins/about.md

@@ -0,0 +1,38 @@
+# What are third-party plugins?
+
+Third-party plugins are a way to extend Commitizen with additional commit message rules.
+
+They are available as PyPI packages (installable with `pip`).
+
+!!! note
+    New plugins are welcome! Once you published your plugins, please send us a PR to update this page.
+
+
+<!-- TODO: explain what are the different types of plugins -->
+
+## New plugin documentation template
+
+Please document what do they provide:
+
+- a convention
+- a scheme
+- a provider
+- a `changelog_format`
+
+Of course, you can provide multiple features. `commitizen` itself is a plugin that provides all the features.
+
+    # [Package name](https://github.com/author/package-name)
+
+    Description of the plugin.
+
+    ## Installation
+
+    ```sh
+    pip install package-name
+    ```
+
+    ## Usage
+
+    ```sh
+    cz --name package-name commit
+    ```

mkdocs.yml

@@ -56,6 +56,8 @@ nav:
       - Monorepo support: "tutorials/monorepo_guidance.md"
   - FAQ: "faq.md"
   - Exit Codes: "exit_codes.md"
+  - Third-Party Commitizen Conventions:
+      - About: "third-party-plugins/about.md"
   - Third-Party Commitizen Rules: "third-party-rules.md"
   - Third-Party Commitizen Providers: "third-party-providers.md"
   - Contributing: "contributing.md"