From 1f9ed21348f16495550aa223f7499208a32fb3be Mon Sep 17 00:00:00 2001 From: Jiacheng Xu Date: Thu, 25 Jul 2024 17:25:11 +0800 Subject: [PATCH] feat: update contribution guideline (#13) * feat: update contribution guideline * generate docs --- CONTRIBUTING.md | 4 ++++ docs/contributing.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 49c57da..6a15eec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -59,6 +59,10 @@ Before adding a new risk type, please check if the risk type ID is already taken Create a folder under [src](https://github.com/cryptousersecurity/token-risk-classification/tree/main/src) folder with the name of the risk type ID. Add folders and files based on the [Risk Type Format](#risk-type-format) section. +### Update mkdocs.yml + +Add the new risk type to the `Risk Types` list under `nav` section in [mkdocs.yml](https://github.com/cryptousersecurity/token-risk-classification/blob/main/mkdocs.yml#L17). + ## Update Documentation Everytime you add a new risk type or add new risk samples to an existing risk type, please update the documentation by executing the following command: ```bash diff --git a/docs/contributing.md b/docs/contributing.md index 49c57da..6a15eec 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -59,6 +59,10 @@ Before adding a new risk type, please check if the risk type ID is already taken Create a folder under [src](https://github.com/cryptousersecurity/token-risk-classification/tree/main/src) folder with the name of the risk type ID. Add folders and files based on the [Risk Type Format](#risk-type-format) section. +### Update mkdocs.yml + +Add the new risk type to the `Risk Types` list under `nav` section in [mkdocs.yml](https://github.com/cryptousersecurity/token-risk-classification/blob/main/mkdocs.yml#L17). + ## Update Documentation Everytime you add a new risk type or add new risk samples to an existing risk type, please update the documentation by executing the following command: ```bash