From c0982a787facca7d8dd801fb125781dce7d8edb2 Mon Sep 17 00:00:00 2001 From: Adam Perkowski Date: Thu, 24 Oct 2024 21:45:37 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20add=20auto=20docs=20generation?= =?UTF-8?q?=20instructions=20to=20the=20Contributing=20Guidelines=20(#788)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 📖 add auto docs generation instructions to the Contributing Guidelines * Commit Contributing Guidelines --------- Co-authored-by: adamperkowski --- .github/CONTRIBUTING.md | 2 ++ docs/contributing.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 5a2c71b1..f0b02574 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -16,6 +16,7 @@ cd linutil ``` ## 3. Make your changes + - **Edit the files you want to change**: Make your changes to the relevant files. - **Test your changes**: Run `cargo run` to test your modifications in a local environment and ensure everything works as expected. @@ -60,6 +61,7 @@ cd linutil ## 11. Documentation - **Update the documentation**: If your change affects the functionality, please update the relevant documentation files to reflect this. +- **Automatic generation**: If you decide to add functionality through a new shell script, make sure to fill out all fields in `tab_data.toml` and run `cargo xtask docgen`. ## 12. License diff --git a/docs/contributing.md b/docs/contributing.md index 4e20b7b7..2eba69f9 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -16,6 +16,7 @@ cd linutil ``` ## 3. Make your changes + - **Edit the files you want to change**: Make your changes to the relevant files. - **Test your changes**: Run `cargo run` to test your modifications in a local environment and ensure everything works as expected. @@ -60,6 +61,7 @@ cd linutil ## 11. Documentation - **Update the documentation**: If your change affects the functionality, please update the relevant documentation files to reflect this. +- **Automatic generation**: If you decide to add functionality through a new shell script, make sure to fill out all fields in `tab_data.toml` and run `cargo xtask docgen`. ## 12. License