👩‍💻 CONTRIBUTING

Welcome! We're glad to have you. If you would like to report a bug, request a new feature or enhancement, follow this link.

❗️ Requirements

Python

modelscan requires python version >=3.9 and <3.13
Poetry

The following install commands require Poetry. To install Poetry you can follow this installation guide. Poetry can also be installed with brew using the command brew install poetry.

Clone the repo

git clone git@github.com:protectai/modelscan.git

To install development dependencies to your environment and set up the cli for live updates, run the following command in the root of the modelscan directory:
```
make install-dev
```
You are now ready to start developing!

Run a scan with the cli with the following command:
```
modelscan -p /path/to/file
```

Thanks for contributing! In order to open a PR into the modelscan project, you'll have to follow these steps:

Fork the repo and clone your fork locally
Run make install-dev from the root of your forked repo to setup your environment
Make your changes
Submit a pull request

After these steps have been completed, someone on our team at Protect AI will review the code and help merge in your changes!