Skip to content

Commit

Permalink
feat: update contribution guideline (#13)
Browse files Browse the repository at this point in the history
* feat: update contribution guideline

* generate docs
  • Loading branch information
jiachengxu authored Jul 25, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent 1ddb269 commit 1f9ed21
Showing 2 changed files with 8 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 1f9ed21

Please sign in to comment.